/ 
Alien-FLTK-0.06879
River stage one • 1 direct dependent • 1 total dependent
/ Alien::FLTK

NAME

Alien::FLTK - Build and use the Fast Light Toolkit binaries

Description

This distribution builds and installs libraries for the (experimental) 2.0.x branch of the FLTK GUI toolkit.

Synopsis

use Alien::FLTK;
use ExtUtils::CBuilder;
my $CC     = ExtUtils::CBuilder->new();
my $source = 'hello_world.cxx';
open(my $FH, '>', $source) || die '...';
syswrite($FH, <<'') || die '...'; close $FH;
  #include <fltk/Window.h>
  #include <fltk/Widget.h>
  #include <fltk/run.h>
  using namespace fltk;
  int main(int argc, char **argv) {
    Window *window = new Window(300, 180);
    window->begin();
    Widget *box = new Widget(20, 40, 260, 100, "Hello, World!");
    box->box(UP_BOX);
    box->labelfont(HELVETICA_BOLD_ITALIC);
    box->labelsize(36);
    box->labeltype(SHADOW_LABEL);
    window->end();
    window->show(argc, argv);
    return run();
  }

my $obj = $CC->compile(source               => $source,
                       extra_compiler_flags => Alien::FLTK->cxxflags());
my $exe = $CC->link_executable(
                              objects            => $obj,
                              extra_linker_flags => Alien::FLTK->ldflags()
);
print system('./' . $exe) ? 'Aww...' : 'Yay!';
END { unlink grep defined, $source, $obj, $exe; }

Methods

include_path

my $include_path = Alien::FLTK->include_path;

Returns the location of the headers installed during the build process.

library_path

my $include_path = Alien::FLTK->library_path;

Returns the location of the private libraries we made and installed during the build process.

cflags

my $cflags = Alien::FLTK->cflags;

Returns additional C compiler flags to be used.

cxxflags

my $cxxflags = Alien::FLTK->cxxflags;

Returns additional flags to be used to when compiling C++ using FLTK.

ldflags

my $ldflags = Alien::FLTK->ldflags(qw[gl images]);

Returns additional linker flags to be used. This method can automatically add appropriate flags based on how you plan on linking to fltk. Acceptable arguments are:

static

Returns flags to link against a static FLTK library.

FLTK's license allows static linking, btw.

gl

Include flags to use GL.

This is an experimental option. Depending on your system, this may also include OpenGL or MesaGL.

images

Include flags to use extra image formats (PNG, JPEG).

revision

my $revision = Alien::FLTK->revision;

Returns the SVN revision number of the source Alien::FLTK was built with.

capabilities

my $caps = Alien::FLTK->capabilities;

Returns a list of capabilities supported by your Alien::FLTK installation. This list can be handed directly to ldflags( ).

config

my $configuration = Alien::FLTK->config;

Returns a hashref containing the raw configuration data collected during build. This would be helpful when reporting bugs, etc.

Notes

Requirements

The Fast Light Toolkit works right out of the box on Windows (MinGW), but for *nix, make sure the following libs are installed first...

X11 libs

On Debian Linux, the X11 development package is listed as libx11-dev.

X11 Input libs

On Debian Linux, the X11 Input development package is listed as libxi-dev.

X11 Cursor libs

On Debian Linux, the X11 Cursor development package is listed as libxcursor-dev.

Note: The Xcursor libs are optional.

Once installed, Alien::FLTK depends on:

Config
File::Spec::Functions
File::Basename
File::Find

Installation

Building the fltk libs requires a functioning C++ compiler, bash, and (to make life easy) a version of make.

The distribution is based on Module::Build, so use the following procedure:

perl Build.PL
./Build
./Build test
./Build install

An attempt has been made to work around an incomplete set of build tools. This fallback requires ExtUtils::CBuilder and plenty of begging. Consider it alpha at best.

  • Issue Tracker

    http://github.com/sanko/alien-fltk/issues

    Please only report Alien::FLTK related bugs to this tracker. For FLTK issues, use http://github.com/sanko/fltk-perl/issues/

  • Commit Log

    http://github.com/sanko/alien-fltk/commits/master

  • Homepage:

    http://sanko.github.com/fltk-perl/ is the homepage of the FLTK project.

  • License:

    http://www.perlfoundation.org/artistic_license_2_0

    See the License and Legal section of this document.

  • Mailing List

    Once I find someone to host a list for the FLTK project, I'll use it for Alien::FLTK too.

  • Repository

    http://github.com/sanko/alien-fltk/ and you are invited to fork it.

Examples

Please see the Synopsis and the files in the /example/.

Bugs

Numerous, I'm sure.

To Do

Please see Alien::FLTK::Todo

See Also

FLTK

Acknowledgments

The FLTK Team - http://www.fltk.org/

Author

Sanko Robinson <sanko@cpan.org> - http://sankorobinson.com/

CPAN ID: SANKO

License and Legal

Copyright (C) 2009 by Sanko Robinson <sanko@cpan.org>

This program is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0. See the LICENSE file included with this distribution or http://www.perlfoundation.org/artistic_license_2_0. For clarification, see http://www.perlfoundation.org/artistic_2_0_notes.

When separated from the distribution, all POD documentation is covered by the Creative Commons Attribution-Share Alike 3.0 License. See http://creativecommons.org/licenses/by-sa/3.0/us/legalcode. For clarification, see http://creativecommons.org/licenses/by-sa/3.0/us/.

Alien::FLTK is based in part on the work of the FLTK project. See http://www.fltk.org/.