PLplotWiki - User contributions [en]

CMake options for PLplot

2009-04-22T21:21:58Z

VZ: /* General options */ Added LIB_TAG

A large number of options are available to modify the CMake configuration process. Use the ccmake command to obtain documentation of all of them. Here we give the documentation of the most heavily used subset of the options. The value specified is the default value, but note that value can automatically be changed by the build system if some essential resource is not available on the platform. For example, if no Fortran 95-capable compiler can be found on the platform, the Fortran 95 bindings are automatically disabled. Furthermore, certain option values depend on other option values. For example, if BUILD_SHARED_LIBS is set to OFF, then ENABLE_DYNDRIVERS is automatically set to OFF as well.

In general, if you just use the default options PLplot will normally configure itself to build without problems. The cmake output will have WARNING messages about any missing components. If one of those is important to you, then you will have to install additional libraries or executables (e.g., a Fortran 95-capable compiler) and do a fresh cmake run in an empty directory to configure a PLplot build that includes the component that was missing before.

== General options ==

'''CMAKE_INSTALL_PREFIX:PATH'''=/usr/local - install directory

'''CMAKE_BUILD_TYPE:STRING'''=Release/Debug - release or debug build of plplot

'''BUILD_SHARED_LIBS:BOOL'''=ON - build shared libraries (ON) or static libraries (OFF)

'''ENABLE_DYNDRIVERS:BOOL'''=ON - build device drivers as dynamically loaded plugins (ON) or as part of the PLplot core C library (OFF)

'''BUILD_TEST:BOOL'''=OFF - builds examples in the build tree so that ctest can be run afterward to test that those examples work

'''PL_DOUBLE:BOOL'''=ON - use 64-bit (ON) or 32-bit (OFF) floating-point precision

'''WITH_CSA:BOOL'''=ON - internally build and use the csirocsa library for bivariate cubic spline approximation

'''BUILD_DOC:BOOL'''=OFF - build documentation (Linux only)

'''LIB_TAG:STRING'''="" - suffix added to all libraries, notice that 'd' is always appended to it if doubles are used and so by default all libraries have 'd' at the end (and it can't be removed by setting this option unfortunately).

== Bindings options ==

'''DEFAULT_NO_BINDINGS:BOOL'''=OFF - turn off all language bindings by default

'''ENABLE_cxx:BOOL'''=ON - C++ bindings

'''ENABLE_f77:BOOL'''=ON - Fortran 77 bindings

'''ENABLE_f95:BOOL'''=ON - Fortran 95 bindings

'''ENABLE_python:BOOL'''=ON - Python bindings

'''ENABLE_java:BOOL'''=ON - Java bindings

'''ENABLE_tcl:BOOL'''=ON - Tcl bindings

'''ENABLE_itcl:BOOL'''=ON - iTcl object-oriented extension of the Tcl bindings

'''ENABLE_tk:BOOL'''=ON - Tk (graphical extension of Tcl) bindings

'''ENABLE_itk:BOOL'''=ON - iTk object-oriented extension of the Tk bindings

'''ENABLE_ada:BOOL'''=ON - Ada 95 and Ada 2005 bindings

'''ENABLE_pdl:BOOL'''=OFF - include PDL (Perl Data Language) examples to be used with PDL PLplot bindings that are developed as part of the external PDL project

'''ENABLE_d:BOOL'''=OFF - Experimental [http://www.digitalmars.com/d/index.html D] bindings

'''ENABLE_ocaml:BOOL'''=ON - [http://caml.inria.fr/ OCaml] bindings

== Device options ==

=== General device options ===
'''DEFAULT_ALL_DEVICES:BOOL'''=OFF

'''DEFAULT_NO_DEVICES:BOOL'''=OFF

'''WITH_FREETYPE:BOOL'''=ON - access TrueType fonts with direct calls to libfreetype for certain device drivers that use this method of accessing TrueType fonts.

=== libpango/libcairo-related devices ===
These devices use various cairo backends. The ones that are turned ON by default generally give beautiful results with properly hinted fonts. The others do not yet work well for the present (2007-12) state of cairo backend development but may work well in the future.

'''PLD_pscairo'''=ON

'''PLD_pdfcairo'''=ON

'''PLD_pngcairo'''=ON

'''PLD_xcairo'''=ON

'''PLD_svgcairo'''=OFF

'''PLD_memcairo'''=OFF

'''PLD_extcairo'''=OFF

=== libgd-related devices ===
'''PLD_png:BOOL'''=ON

'''PLD_jpeg:BOOL'''=ON

'''PLD_gif:BOOL'''=ON

=== Hewlett-Packard printer devices ===
'''PLD_hp7470:BOOL'''=ON

'''PLD_hp7580:BOOL'''=ON

'''PLD_lj_hpgl:BOOL'''=ON

=== Textronix and Textronix emulator devices ===
'''PLD_xterm:BOOL'''=OFF

'''PLD_tek4010:BOOL'''=OFF

'''PLD_tek4010f:BOOL'''=OFF

'''PLD_tek4107:BOOL'''=OFF

'''PLD_tek4107f:BOOL'''=OFF

'''PLD_mskermit:BOOL'''=OFF

'''PLD_versaterm:BOOL'''=OFF

'''PLD_vlt:BOOL'''=OFF

'''PLD_conex:BOOL'''=OFF

=== Other devices ===
'''PLD_aqt:BOOL'''=ON

'''PLD_cgm:BOOL'''=ON

'''PLD_dg300:BOOL'''=OFF

'''PLD_gcw:BOOL'''=ON

'''PLD_imp:BOOL'''=OFF

'''PLD_linuxvga:BOOL'''=OFF

'''PLD_ljii:BOOL'''=OFF

'''PLD_ljiip:BOOL'''=OFF

'''PLD_mem:BOOL'''=ON

'''PLD_ntk:BOOL'''=OFF

'''PLD_null:BOOL'''=ON

'''PLD_pbm:BOOL'''=ON

'''PLD_pdf:BOOL'''=OFF

'''PLD_plmeta:BOOL'''=OFF

'''PLD_ps:BOOL'''=ON

'''PLD_pstex:BOOL'''=OFF

'''PLD_psttf:BOOL'''=ON

'''PLD_svg:BOOL'''=ON

'''PLD_tk:BOOL'''=ON

'''PLD_tkwin:BOOL'''=ON

'''PLD_wingcc:BOOL'''=ON

'''PLD_wxwidgets:BOOL'''=ON

'''PLD_xfig:BOOL'''=ON

'''PLD_xwin:BOOL'''=ON

Configure PLplot for Visual CXX CLI

2009-03-20T12:55:25Z

VZ: Explain the importance of setting the PATH before building and mention that wxWidgets DLLs should be in the PATH as well if you use them.

You need a working Visual C++ installation. Start the command line interface and issue the following commands:

cd plplot
mkdir buildnmake
cd buildnmake
cmake -G "NMake Makefiles" -DCMAKE_INSTALL_PREFIX=install ..
path=...\plplot\buildnmake\dll;%PATH%
nmake
nmake install

This will build a shared plplot library and install all files into the directory <tt>plplot\buildnmake\install</tt>.

'''Note''': during the build the various DLLs are put in the subdirectory "dll" under the build directory. It is important
that this directory is contained in the path during the build, if you use the dynamic drivers facility as otherwise calls to get-drv-info will fail and the drivers won't be installed successfully. In addition, if you use wxWidgets driver you also must ensure that the wxWidgets DLL itself is in the path as well.

Alternatively you can use the GUI version of CMake, an easy-to-use user-interface that presents the available build options
and lets you set them. It is mostly a matter of taste, but:
* The GUI version provides an overview of the build opions that are available
* The command-line version is particularly useful if you are experimenting with these options, as it can be run from a batchfile

Some of the options that are available for cmake:

* <tt>-DBUILD_SHARED_LIBS=OFF</tt>: static build of plplot
* <tt>-DCMAKE_VERBOSE_MAKEFILE=ON</tt>: makefiles provide verbose informations
* <tt>-DBUILD_TEST=ON</tt>: all examples will be built also (for test purposes)
* [[Configuration of wxWidgets driver]]

If you used the <tt>-DBUILD_TEST=ON</tt> option, you need to copy some files in order to run the examples:

cd examples\c
copy ..\..\..\data\*.fnt .

and additionally some dlls for a shared plplot built:

copy ..\..\dll\plplotd.dll .
copy ..\..\dll\plplotcxxd.dll . (for c++ examples)
copy ..\..\dll\csirocsa.dll . (if library was built)

and for the wxWidgets driver (if wxWidgets library is shared):

copy %WXWIN%\lib\gcc_dll\wxmsw26d_vc_custom.dll .

if this dll is not in the path.

Configuration of wxWidgets driver

2009-03-10T15:27:03Z

VZ: /* CMake Options */ Add note about editing flags.make

== CMake Options ==

The following options let you specify to the CMake build system what options you used to compile your wxWidgets libraries:

* <tt>-DwxWidgets_LIB_DIR=%WXWIN%\lib\gcc_lib</tt>: correct for your wxWidgets root directory and static vs. dynamic libraries
* <tt>-DwxWidgets_CONFIGURATION=mswu</tt>: msw -> MicroSoft Windows; u -> Unicode; d -> Debug
* <tt>-DwxWidgets_MONOLITHIC=ON</tt>: monolithic as opposed to individual libraries
* <tt>-DwxWidgets_USE_UNICODE=ON</tt>: compiled with Unicode support

For more options refer to FindwxWidgets.cmake in your CMake installation.

More may be required for a successful Unicode build. Depending, incorrect Unicode configuration may result in errors during PLplot compilation or may not show up until later when compiling your actual application. Example errors are as follows:

[ 60%] Building CXX object bindings/wxwidgets/CMakeFiles/plplotwxwidgetsd.dir/wx
PLplotwindow.obj
Linking CXX shared library ..\..\dll\libplplotwxwidgetsd.dll
Creating library file: ..\..\dll\libplplotwxwidgetsd.dll.a
CMakeFiles\plplotwxwidgetsd.dir\wxPLplotwindow.obj:wxPLplotwindow.cpp:(.text$_ZN
12wxStringBaseC2EPKc[wxStringBase::wxStringBase(char const*)]+0x27): undefined r
eference to `_imp___ZN12wxStringBase8InitWithEPKcjj'
collect2: ld returned 1 exit status

D:\Projects\wxWidgetsTest\Libraries\plplot-5.9.2\buildmingw\install\lib/libplplotd.a(wxwidgets.obj):wxwidgets.cpp:(.text+0xd2a):
undefined reference to `wxStringBase::InitWith(char const*, unsigned
int, unsigned int)'
D:\Projects\wxWidgetsTest\Libraries\plplot-5.9.2\buildmingw\install\lib/libplplotd.a(wxwidgets.obj):wxwidgets.cpp:(.text+0xd6e):
undefined reference to `wxStringBase::InitWith(char const*, unsigned
int, unsigned int)'
- followed by a bunch more undefined references

Note that in both cases the errors do not specify a Unicode error but are string or character related. The follow was mentioned on the maillist and worked for me:

This is due a bug FindwxWidgets.cmake, either add

add_definitions(-D_UNICODE)

to CMakeLists.txt in the plplot main file. Or look for wxUNICODE in gcc_dll/mswu/setup.h
(or similar) and set it to 1. This flag is always 0 even if you compiled wxWidgets with
UNICODE=1, you have to do it on your own, or set the _UNICODE flag on the command line.

If this still doesn't work (it didn't seem to have any effect for me), try editing the file flags.make in bindings/wxwidgets/CMakeFiles/plplotwxwidgetsd.dir and add <tt>/D_UNICODE /DUNICODE</tt> to the definition of <tt>CXX_FLAGS</tt> there.

== Antialiasing ==

The wxwidgets driver provides antialzing support, which can be turned on with the option antialized=1.

Output of example 1 with antializing OFF:
[[Image:non_antialized.png|800px|non antialized]]

Output of example 1 with antializing ON:
[[Image:antialized.png|800px|antialized]]