Build.PL - metacpan.org

#! perl -w
#
# Copyright (C) 2003 chromatic
# Copyright (C) 2004 David J. Goehrig
# Copyright (C) 2010 Kartik Thakore

use strict;
use warnings;
use Carp;

use lib 'inc';
use Alien::SDL;

print STDERR <<BROKENMSG;
*************************** !!!WARNING!!! ********************************
This Release breaks back compatibility support with versions 2.4x and below
**************************************************************************
BROKENMSG

### We need the platform-specific module
my %platforms = (
	MSWin32     => 'Windows',
	MacOS       => 'Darwin',
	darwin      => 'Darwin',
	cygwin      => 'Unix',
	freebsd     => 'Unix',
	gnukfreebsd => 'Unix',
	linux       => 'Unix',
	netbsd      => 'Unix',
	openbsd     => 'Unix',
	solaris     => 'Unix',
);
my $package = 'My::Builder::' . ( $platforms{$^O} || 'Unix' );
print "Using '$package' class ...\n";
eval "require $package" or Carp::confess "Require '$package' failed: $@\n";

### Subsystems to build
#    <subsystem>
#        <file> = hash of the following 2 values:
#            <from> = location of source file
#            <to>   = location of build file to get name right
#        <libraries> = list reqiured libraries, names the same as keys to hash %libraries
my %subsystems = (
	SDL => {
		file => {
			from => 'src/SDL.xs',
			to   => 'lib/SDL_perl.xs',
		},
		libraries => [qw( SDL )],
	},
	Time => {
		file => {
			from => 'src/Core/Time.xs',
			to   => 'lib/SDL/Time.xs',
		},
		libraries => [qw( SDL )],
	},
	Events => {
		file => {
			from => 'src/Core/Events.xs',
			to   => 'lib/SDL/Events.xs',
		},
		libraries => [qw( SDL )],
	},
	Event => {
		file => {
			from => 'src/Core/objects/Event.xs',
			to   => 'lib/SDL/Event.xs',
		},
		libraries => [qw( SDL )],
	},
	GFX => {
		file => {
			from => 'src/GFX/GFX.xs',
			to   => 'lib/SDL/GFX.xs',
		},
		libraries => [qw( SDL SDL_gfx_primitives )],
	},
	BlitFunc => {
		file => {
			from => 'src/GFX/BlitFunc.xs',
			to   => 'lib/SDL/GFX/BlitFunc.xs',
		},
		libraries => [qw( SDL SDL_gfx_blitfunc )],
	},
	Framerate => {
		file => {
			from => 'src/GFX/Framerate.xs',
			to   => 'lib/SDL/GFX/Framerate.xs',
		},
		libraries => [qw( SDL SDL_gfx_framerate )],
	},
	FPSManager => {
		file => {
			from => 'src/GFX/FPSManager.xs',
			to   => 'lib/SDL/GFX/FPSManager.xs',
		},
		libraries => [qw( SDL SDL_gfx_framerate )],
	},
	ImageFilter => {
		file => {
			from => 'src/GFX/ImageFilter.xs',
			to   => 'lib/SDL/GFX/ImageFilter.xs',
		},
		libraries => [qw( SDL SDL_gfx_imagefilter )],
	},
	Primitives => {
		file => {
			from => 'src/GFX/Primitives.xs',
			to   => 'lib/SDL/GFX/Primitives.xs',
		},
		libraries => [qw( SDL SDL_gfx_primitives )],
	},
	Rotozoom => {
		file => {
			from => 'src/GFX/Rotozoom.xs',
			to   => 'lib/SDL/GFX/Rotozoom.xs',
		},
		libraries => [qw( SDL SDL_gfx_rotozoom )],
	},
	MultiThread => {
		file => {
			from => 'src/Core/MultiThread.xs',
			to   => 'lib/SDL/MultiThread.xs',
		},
		libraries => [qw( SDL )],
	},
	Video => {
		file => {
			from => 'src/Core/Video.xs',
			to   => 'lib/SDL/Video.xs',
		},
		libraries => [qw( SDL )],
	},
	Audio => {
		file => {
			from => 'src/Core/Audio.xs',
			to   => 'lib/SDL/Audio.xs',
		},
		libraries => [qw( SDL )],
	},
	Rect => {
		file => {
			from => 'src/Core/objects/Rect.xs',
			to   => 'lib/SDL/Rect.xs',
		},
		libraries => [qw( SDL )],
	},
	Color => {
		file => {
			from => 'src/Core/objects/Color.xs',
			to   => 'lib/SDL/Color.xs',
		},
		libraries => [qw( SDL )],
	},
	Surface => {
		file => {
			from => 'src/Core/objects/Surface.xs',
			to   => 'lib/SDL/Surface.xs',
		},
		libraries => [qw( SDL )],
	},
	SurfaceX => {
		file => {
			from => 'src/SDLx/Surface.xs',
			to   => 'lib/SDLx/Surface.xs',
		},
		libraries => [qw( SDL SDL_gfx_primitives )],
	},
	TimerX => {
		file => {
			from => 'src/SDLx/Timer.xs',
			to   => 'lib/SDLx/Controller/Timer.xs',
		},
		libraries => [qw( SDL )],
	},
	ValidateX => {
		file => {
			from => 'src/SDLx/Validate.xs',
			to   => 'lib/SDLx/Validate.xs',
		},
		libraries => [qw( SDL )],
	},
	InterfaceX => {
		file => {
			from => 'src/SDLx/Controller/Interface.xs',
			to   => 'lib/SDLx/Controller/Interface.xs',
		},
		libraries => [qw( SDL  )],
	},
	StateX => {
		file => {
			from => 'src/SDLx/Controller/State.xs',
			to   => 'lib/SDLx/Controller/State.xs',
		},
		libraries => [qw( SDL  )],
	},
	Overlay => {
		file => {
			from => 'src/Core/objects/Overlay.xs',
			to   => 'lib/SDL/Overlay.xs',
		},
		libraries => [qw( SDL )],
	},
	RWOps => {
		file => {
			from => 'src/Core/objects/RWOps.xs',
			to   => 'lib/SDL/RWOps.xs',
		},
		libraries => [qw( SDL )],
	},
	PixelFormat => {
		file => {
			from => 'src/Core/objects/PixelFormat.xs',
			to   => 'lib/SDL/PixelFormat.xs',
		},
		libraries => [qw( SDL )],
	},
	LayerManagerX => {
		file => {
			from => 'src/SDLx/LayerManager.xs',
			to   => 'lib/SDLx/LayerManager.xs',
		},
		libraries => [qw( SDL )],
	},
	LayerX => {
		file => {
			from => 'src/SDLx/Layer.xs',
			to   => 'lib/SDLx/Layer.xs',
		},
		libraries => [qw( SDL SDL_image )],
	},
	AudioSpec => {
		file => {
			from => 'src/Core/objects/AudioSpec.xs',
			to   => 'lib/SDL/AudioSpec.xs',
		},
		libraries => [qw( SDL )],
	},
	AudioCVT => {
		file => {
			from => 'src/Core/objects/AudioCVT.xs',
			to   => 'lib/SDL/AudioCVT.xs',
		},
		libraries => [qw( SDL )],
	},
	Mixer => {
		file => {
			from => 'src/Mixer/Mixer.xs',
			to   => 'lib/SDL/Mixer.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixerSamples => {
		file => {
			from => 'src/Mixer/Samples.xs',
			to   => 'lib/SDL/Mixer/Samples.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixerChannels => {
		file => {
			from => 'src/Mixer/Channels.xs',
			to   => 'lib/SDL/Mixer/Channels.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixerGroups => {
		file => {
			from => 'src/Mixer/Groups.xs',
			to   => 'lib/SDL/Mixer/Groups.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixerMusic => {
		file => {
			from => 'src/Mixer/Music.xs',
			to   => 'lib/SDL/Mixer/Music.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixerEffects => {
		file => {
			from => 'src/Mixer/Effects.xs',
			to   => 'lib/SDL/Mixer/Effects.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixChunk => {
		file => {
			from => 'src/Mixer/objects/MixChunk.xs',
			to   => 'lib/SDL/Mixer/MixChunk.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	MixMusic => {
		file => {
			from => 'src/Mixer/objects/MixMusic.xs',
			to   => 'lib/SDL/Mixer/MixMusic.xs',
		},
		libraries => [qw( SDL SDL_mixer )],
	},
	Palette => {
		file => {
			from => 'src/Core/objects/Palette.xs',
			to   => 'lib/SDL/Palette.xs',
		},
		libraries => [qw( SDL )],
	},
	VideoInfo => {
		file => {
			from => 'src/Core/objects/VideoInfo.xs',
			to   => 'lib/SDL/VideoInfo.xs',
		},
		libraries => [qw( SDL )],
	},
	Mouse => {
		file => {
			from => 'src/Core/Mouse.xs',
			to   => 'lib/SDL/Mouse.xs',
		},
		libraries => [qw( SDL )],
	},
	Cursor => {
		file => {
			from => 'src/Core/objects/Cursor.xs',
			to   => 'lib/SDL/Cursor.xs',
		},
		libraries => [qw( SDL )],
	},
	Joystick => {
		file => {
			from => 'src/Core/Joystick.xs',
			to   => 'lib/SDL/Joystick.xs',
		},
		libraries => [qw( SDL )],
	},
	CDROM => {
		file => {
			from => 'src/Core/CDROM.xs',
			to   => 'lib/SDL/CDROM.xs',
		},
		libraries => [qw( SDL )],
	},
	CDTrack => {
		file => {
			from => 'src/Core/objects/CDTrack.xs',
			to   => 'lib/SDL/CDTrack.xs',
		},
		libraries => [qw( SDL )],
	},
	CD => {
		file => {
			from => 'src/Core/objects/CD.xs',
			to   => 'lib/SDL/CD.xs',
		},
		libraries => [qw( SDL )],
	},
	TTF => {
		file => {
			from => 'src/TTF/TTF.xs',
			to   => 'lib/SDL/TTF.xs',
		},
		libraries => [qw( SDL SDL_ttf )],
	},
	TTF_Font => {
		file => {
			from => 'src/TTF/objects/Font.xs',
			to   => 'lib/SDL/TTF/Font.xs',
		},
		libraries => [qw( SDL SDL_ttf )],
	},
	Version => {
		file => {
			from => 'src/Core/objects/Version.xs',
			to   => 'lib/SDL/Version.xs',
		},
		libraries => [qw( SDL )],
	},
	Image => {
		file => {
			from => 'src/Image.xs',
			to   => 'lib/SDL/Image.xs',
		},
		libraries => [qw( SDL SDL_image )],
	},
	SFont => {
		file => {
			from => 'src/SDLx/SFont.xs',
			to   => 'lib/SDLx/SFont.xs',
		},
		libraries => [qw( SDL SDL_image )],
	},

#	SMPEG => {
#			file	=> {
#				from => 'src/SMPEG.xs',
#				to   =>	'lib/SDL/SMPEG.xs',
#			},
#			libraries => [qw( SDL smpeg)],
#		},
#	MPEG => {
#			file	=> {
#				from => 'src/SMPEG/Info.xs',
#				to   =>	'lib/SDL/SMPEG/Info.xs',
#			},
#			libraries => [qw( SDL smpeg)],
#		},
	Pango => {
		file => {
			from => 'src/Pango/Pango.xs',
			to   => 'lib/SDL/Pango.xs',
		},
		libraries => [qw( SDL SDL_Pango )],
	},
	Context => {
		file => {
			from => 'src/Pango/objects/Context.xs',
			to   => 'lib/SDL/Pango/Context.xs',
		},
		libraries => [qw( SDL SDL_Pango )],
	},

	#	Net => {
	#		file      => {
	#			from  => 'src/Net/Net.xs',
	#			to    => 'lib/SDL/Net.xs',
	#		},
	#		libraries => [qw( SDL SDL_net )],
	#	},
	#	TCP => {
	#		file      => {
	#			from  => 'src/Net/TCP.xs',
	#			to    => 'lib/SDL/Net/TCP.xs',
	#		},
	#		libraries => [qw( SDL SDL_net )],
	#	},
	#	UDP => {
	#		file      => {
	#			from  => 'src/Net/UDP.xs',
	#			to    => 'lib/SDL/Net/UDP.xs',
	#		},
	#		libraries => [qw( SDL SDL_net )],
	#	},
	#	IPaddress => {
	#		file      => {
	#			from  => 'src/Net/objects/IPaddress.xs',
	#			to    => 'lib/SDL/Net/IPaddress.xs',
	#		},
	#		libraries => [qw( SDL SDL_net )],
	#	},

);

### External libraries
#    <library name> = symbolic library name
#        <define> = value that will be used as -D<value> option when compiling XS code
#        <header> = header related to the library that will be used for avalability detection,
#                   could be a sigle value or an array of values
#        <lib>    = value that will be used as -l<value> option when linking XS code
my %libraries = (
	SDL => {
		define => 'HAVE_SDL',
		header => 'SDL.h',
		lib    => 'SDL',
	},
	SDL_image => {
		define => 'HAVE_SDL_IMAGE',
		header => 'SDL_image.h',
		lib    => 'SDL_image',
	},
	SDL_mixer => {
		define => 'HAVE_SDL_MIXER',
		header => 'SDL_mixer.h',
		lib    => 'SDL_mixer',
	},

	#	SDL_net     => {
	#		define => 'HAVE_SDL_NET',
	#		header => 'SDL_net.h',
	#		lib    => 'SDL_net',
	#	},
	SDL_ttf => {
		define => 'HAVE_SDL_TTF',
		header => 'SDL_ttf.h',
		lib    => 'SDL_ttf',
	},
	SDL_gfx => {
		define => 'HAVE_SDL_GFX',
		header => 'SDL_gfxPrimitives.h',
		lib    => 'SDL_gfx',
	},
	SDL_gfx_blitfunc => {
		define => 'HAVE_SDL_GFX_BLITFUNC',
		header => 'SDL_gfxBlitFunc.h',
		lib    => 'SDL_gfx',
	},
	SDL_gfx_framerate => {
		define => 'HAVE_SDL_GFX_FRAMERATE',
		header => 'SDL_framerate.h',
		lib    => 'SDL_gfx',
	},
	SDL_gfx_imagefilter => {
		define => 'HAVE_SDL_GFX_IMAGEFILTER',
		header => 'SDL_imageFilter.h',
		lib    => 'SDL_gfx',
	},
	SDL_gfx_primitives => {
		define => 'HAVE_SDL_GFX_PRIMITIVES',
		header => 'SDL_gfxPrimitives.h',
		lib    => 'SDL_gfx',
	},
	SDL_gfx_rotozoom => {
		define => 'HAVE_SDL_GFX_ROTOZOOM',
		header => 'SDL_rotozoom.h',
		lib    => 'SDL_gfx',
	},
	SDL_Pango => {
		define => 'HAVE_SDL_PANGO',
		header => 'SDL_Pango.h',
		lib    => 'SDL_Pango',
	},
	png => {
		define => 'HAVE_PNG',
		header => 'png.h',
		lib    => 'png',
	},
	jpeg => {
		define => 'HAVE_JPEG',
		header => 'jpeglib.h',
		lib    => 'jpeg',
	},
	tiff => {
		define => 'HAVE_TIFF',
		header => 'tiff.h',
		lib    => 'tiff',
	},

	smpeg => {
		define => 'HAVE_SMPEG',
		header => 'smpeg/smpeg.h',
		lib    => 'smpeg',
	},
	GL => {
		define => 'HAVE_GL',
		header => [ 'GL/gl.h', 'GL/glext.h' ],
		lib    => ( $^O =~ /^(MSWin32|cygwin)$/ )
		? 'opengl32'
		: 'GL', # xxx not nice
	},
	GLU => {
		define => 'HAVE_GLU',
		header => 'GL/glu.h',
		lib    => ( $^O =~ /^(MSWin32|cygwin)$/ ) ? 'glu32' : 'GLU', # xxx not nice
	},
);

### Mangle the compilable files into a format Module::Build can understand
my %xs =
	map { $subsystems{$_}{file}{from} => $subsystems{$_}{file}{to} }
	keys %subsystems;

### Standard Module::Build stuff
$My::Builder::config = $My::Builder::config;       # Prevent a warning
my $build = $package->new(
	module_name        => 'SDL',
	dist_name          => 'SDL',
	license            => 'lgpl',
	dist_version_from  => 'lib/SDL.pm',
	configure_requires => {
		'ExtUtils::CBuilder' => '0.260301',
		'Alien::SDL'         => '1.442',
		'File::Find'         => '0',
		'File::ShareDir'     => '1.0',
		'Tie::Simple'        => '0',
		'Capture::Tiny'      => '0',
	},
	build_requires => {
		'Test::Simple'      => '0.88',
   		'Capture::Tiny'     => '0',
		'Test::Most'        => '0.21',
		'Alien::SDL'        => '1.442',
		'File::Find'        => '0',
		'File::ShareDir'    => '1.0',
		'Tie::Simple'       => '0',
		'Scalar::Util'      => '0',
	},
	requires => {
		'Scalar::Util'   => '0',
		'Tie::Simple'    => '0',
		'File::ShareDir' => '1.0',
		'CPAN'           => '1.92',
		'perl'           => '5.008000',
	},
	share_dir => 'share',

	build_recommends => {
		'Pod::ToDemo' => '0.20',
	},
	config   => $My::Builder::config,
	c_source => 'src',
	xs_files => \%xs,
	meta_add => {},
	typemap_files => { 'typemap' => 'lib/SDL/typemap' },

	#create_readme => 1, ### make sense only if there is some POD doc in the file specified by dist_version_from
	meta_merge => {
		resources => {
			bugtracker => 'http://github.com/PerlGameDev/SDL/issues',
			repository => 'http://github.com/PerlGameDev/SDL'
		}
	},
	dist_abstract => 'SDL bindings to Perl',
	dist_author   => 'Kartik Thakore <KTHAKORE@cpan.org>',
);

### Alien::SDL quick check
warn "###WARNING### Alien::SDL seems to be broken"
	unless Alien::SDL->config('prefix');

### See which subsystems can be built -- do we have headers for them?
print "Detecting available libraries ...\n";
my $build_systems = $build->find_subsystems( \%subsystems, \%libraries );
my $lib_translate = $build->translate_table( \%subsystems, \%libraries );

### Save info about available subsystems for future SDL::ConfigData
print "Writing config_data ...\n";
$build->config_data( 'SDL_cfg',           $build_systems );
$build->config_data( 'SDL_lib_translate', $lib_translate );
$build->config_data( 'subsystems',        \%subsystems );
$build->config_data( 'libraries',         \%libraries );

### Something that was originally special to MacOS/Darwin
# somebody MacOS/Darwin friendly should review whether it is still necessary
$build->special_build_settings();

### Get some info into M::B notes
print "Saving some info to 'notes' ...\n";
$build->notes( 'subsystems',    \%subsystems );
$build->notes( 'libraries',     \%libraries );
$build->notes( 'build_systems', $build_systems );
$build->notes( 'sdl_cflags',    Alien::SDL->config('cflags') );
$build->notes( 'sdl_libs',      Alien::SDL->config('libs') );
$build->set_file_flags(); # creates notes('file_flags')
$build->add_build_element('typemap');
$build->create_build_script();
	Global
`s`	Focus search bar
`?`	Bring up this help dialog
	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)
	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse
	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)