Compiling Player 3 clients and plugins

From The Player Project

Revision as of 23:12, 30 January 2011 by Rmattes (Talk | contribs)
Jump to: navigation, search

While clients and plugins (both drivers and interfaces) in Player 3 can still be compiled using plain old Makefiles (or any other build system, for that matter), it is now particularly easy to compile them using CMake. This is because Player installs CMake modules for compiling clients, plugin drivers and plugin interfaces. The CMake modules take care of all the work of finding Player and linking to it for you.

The modules are installed in ${prefix}/share/cmake/Modules/. They are UsePlayerC.cmake, UsePlayerC++.cmake and UsePlayerPlugin.cmake. The Player examples installed in ${prefix}/share/player/examples/ all include CMakeLists.txt files that use these modules to compile the examples. See the README file in each directory for how to do so.

For a tutorial on how to integrate these functions into your project, please see Player and CMake


Compiling C clients

The UsePlayerC.cmake module enables compiling of C clients using the libplayerc client library. A minimal example is shown below.

SET (CMAKE_MODULE_PATH /home/geoff/share/cmake/Modules)
INCLUDE (UsePlayerC)

This is all that is necessary for a simple client. If your client requires extra options, such as include search paths, libraries to link to, and so on, specify these to PLAYER_ADD_PLAYERC_CLIENT() as well. Use the standard CMake commands to perform such functions as searching for libraries, using pkg-config, etc.

Compiling C++ clients

The UsePlayerC++.cmake module enables compiling of C++ clients using the libplayerc++ client library. A minimal example is shown below.

SET (CMAKE_MODULE_PATH /home/geoff/share/cmake/Modules)
INCLUDE (UsePlayerC++)

As with C clients, if your client requires extra options, specify these to PLAYER_ADD_PLAYERCPP_CLIENT(), and use the standard CMake commands for other build script functionality.

Compiling plugin drivers

The UsePlayerPlugin.cmake module provides functionality for compiling plugin drivers. A minimal example is shown below.

SET (CMAKE_MODULE_PATH /home/geoff/share/cmake/Modules)
INCLUDE (UsePlayerPlugin)

The macro works in the same way as the client macros.

Compiling plugin interfaces

The UsePlayerPlugin.cmake module allows compiling plugin interfaces. A minimal example is shown below.

SET (CMAKE_MODULE_PATH /home/geoff/share/cmake/Modules)
INCLUDE (UsePlayerPlugin)
INCLUDE (UsePlayerC)

PLAYER_ADD_PLUGIN_INTERFACE (example 128_example.def SOURCES eginterf_client.c)
# Note the use of files generated during the PLAYER_ADD_PLUGIN_INTERFACE step
PLAYER_ADD_PLUGIN_DRIVER (example_driver SOURCES example_interface.h example_xdr.h)
PLAYER_ADD_PLAYERC_CLIENT (example_client SOURCES example_client.c example_interface.h)
TARGET_LINK_LIBRARIES (example_client example)

This CMakeLists.txt is also compiling a C client and a plugin driver that uses the plugin interface, hence the length. It adds the ${PROJECT_BINARY_DIR} (i.e. where generated and compiled files are placed by CMake) to the include path, because the interface plugin creation involves generating some header files. The plugin interface is created first, followed by creating the driver and the client using the files generated during the interface plugin creation. The client must also be linked to the interface plugin library so that it can find the interface's XDR functions at runtime.



PLAYER_ADD_PLAYERC_CLIENT (_clientName <variable args>)

Include: UsePlayerC

Macro to build a simple client. Pass source files, flags, etc. as extra args preceded by keywords as follows:


Invalid language.

You need to specify a language like this: <source lang="html4strict">...</source>

Supported languages for syntax highlighting:

4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, algol68, apache, applescript, apt_sources, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, erlang, f1, fo, fortran, freebasic, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, hicest, hq9plus, html4strict, icon, idl, ini, inno, intercal, io, j, java, java5, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, mmix, modula2, modula3, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml, ocaml-brief, oobas, oracle11, oracle8, oxygene, oz, pascal, pcre, per, perl, perl6, pf, php, php-brief, pic16, pike, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, vala, vb, vbnet, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xorg_conf, xpp, z80, zxbasic

Personal tools