This is glibmm, a C++ API for parts of glib that are useful for C++.
See http://www.gtkmm.org

# Building

Whenever possible, you should use the official binary packages approved by the
supplier of your operating system, such as your Linux distribution.

## Building on Windows

See README.win32

## Building from a release tarball

Extract the tarball and go to the extracted directory:
  $ tar xf glibmm-@GLIBMM_VERSION@.tar.xz
  $ cd glibmm-@GLIBMM_VERSION@

It's easiest to build with Meson, if the tarball was made with Meson,
and to build with Autotools, if the tarball was made with Autotools.
Then you don't have to use maintainer-mode.

How do you know how the tarball was made? If it was made with Meson,
it contains files in untracked/glib/glibmm/, untracked/gio/giomm/ and
other subdirectories of untracked/.

### Building from a tarball with Meson

Don't call the builddir 'build'. There is a directory called 'build' with
files used by Autotools.

  $ meson --prefix /some_directory --libdir lib your_builddir .
  $ cd your_builddir

If the tarball was made with Autotools, you must enable maintainer-mode:
  $ meson configure -Dmaintainer-mode=true

Then, regardless of how the tarball was made:
  $ ninja
  $ ninja install
You can run the tests like so:
  $ ninja test

### Building from a tarball with Autotools

If the tarball was made with Autotools:
  $ ./configure --prefix=/some_directory
If the tarball was made with Meson, you must enable maintainer-mode:
  $ ./autogen.sh --prefix=/some_directory

Then, regardless of how the tarball was made:
  $ make
  $ make install
You can build the examples and tests, and run the tests, like so:
  $ make check

## Building from git

Building from git can be difficult so you should prefer building from
a release tarball unless you need to work on the glibmm code itself.

jhbuild can be a good help
  https://gitlab.gnome.org/GNOME/jhbuild
  https://wiki.gnome.org/Projects/Jhbuild

### Building from git with Meson

Maintainer-mode is enabled by default when you build from a git clone.

Don't call the builddir 'build'. There is a directory called 'build' with
files used by Autotools.

  $ meson --prefix /some_directory --libdir lib your_builddir .
  $ cd your_builddir
  $ ninja
  $ ninja install
You can run the tests like so:
  $ ninja test
You can create a tarball like so:
  $ ninja dist

### Building from git with Autotools

  $ ./autogen.sh --prefix=/some_directory
  $ make
  $ make install
You can build the examples and tests, and run the tests, like so:
  $ make check
You can create a tarball like so:
  $ make distcheck
or
  $ make dist

Building gtkmm under Sun Solaris
================================

This README refers currently only to Sun Forte[tm] C++ compiler (WS6U2)
under Solaris 8/Sparc.

The described procedure to compile gtkmm with Sun's commercial C++
compiler assumes the default compiler installation of Forte[tm] C++ 6
update 2. Furthermore all currently available product and adequate SunOS
patches for Forte[tm] C++ 6 update 2, which can be donwload from the
links given at http://access1.sun.com/sundev/fdp6u2-patches.html, have
to be applied. After that your compiler should give the following
version information:

  $ CC -V
  CC: Sun WorkShop 6 update 2 C++ 5.3 Patch 111685-10 2002/09/16

You will not be able to compile gtkmm with the unpatched compiler
installation. Also, it is important to hide any gcc installation
from your PATH.


The installation procedure:

* Recent version of the following GNU utilities should be avalaible in
  your PATH:

    make        (3.79.1)
    libtool     (1.4.2)
    m4          (1.4)
    perl        (5.6.1)

    The version information (in brackets) apply to my GNU installation.

* Assumed your compiler installation is in /opt/SUNWspro, the following
  environment changes are required:

    PATH=/opt/SUNWspro/bin:$PATH
    LD_LIBRARY_PATH=/opt/SUNWspro/bin:$LD_LIBRARY_PATH
    export PATH LD_LIBRARY_PATH

    CC="cc"
    CXX="CC"
    LD="CC"
    CFLAGS="-g"         or "-g -xO3" for better optimization
    CXXFLAGS="-g"       or "-g -O3" for better optimization
    export CC CXX LD CFLAGS CXXFLAGS

* Select an installation directory ($PREFIX).

* The image libraries jpeg-6b, libpng-1.2.5 and tiff-v3.5.7 are pre-
  requisites to build gtk+ libraries. They can be obtained from
  www.sunfreeware.com or build from source. Compiling from source
  requires some manual corrections (basically prefix settings in the
  makefiles), because their build mechanism are rather old. All three
  libraries should be build as shared libraries and installed to the
  choosen installation directory.

* gtk+-Installation. For each package of pkgconfig-0.12.0, glib-2.0.6,
  atk-1.0.3, pango-1.0.4, gtk+-2.0.6 do:

    cd <package-path>
    CPPFLAGS=-I$PREFIX/include CFLAGS="-I$PREFIX/include $CFLAGS" \
    ./configure --prefix=$PREFIX
    make
    make install

* gtkmm-Installation. For each package of libsigc++-1.2.x, gtkmm-2.0.x do:

    cd <package-path>
    ./configure --prefix=$PREFIX
    make
    make install

* Verification can easily done by

    cd gtkmm-1.2.x/examples
    make

    and testing all built executables.


Feel free to contact the gtkmm mailing list in case of problems compiling gtkmm under Sun
Solaris.


Michael v. Szombathely, 31-Oct-02
<szombath@bifab.de>

Building glibmm on Win32
===========================

Currently, both the mingw (native win32) gcc compiler and MS Visual
Studio 2015 and later are supported. glibmm can be built with
mingw32-gcc using the gnu autotools (automake, autoconf, libtool).
As explicitly stated in the gtk+ for win32 distribution
(http://www.gimp.org/win32/), the gcc compiler provided by the cygwin
distribution should not be used to build glib/glibmm libraries and/or
applications (see the README.win32 that comes with the gtk+ DLLs).
This MIGHT cause conflicts between the cygwin and msvcrt runtime
environments.

1. Mingw

The mingw distribution which has been tested with this release is the
following :

* MinGW-4.1 as the base distribution.

The bare mingw distribution does not provide the necessary tools (sh, perl, m4
, autoconf, automake, ..) to run the provided configure script "as is". One
(currently non supported) solution is to use mingw in conjunction with msys,
which is readily available on the mingw website (http://www.mingw.org/).

The preferred method is to combine the cygwin distribution (for the unix tools
that were mentioned above) with mingw by making sure that the mingw
tools (gcc, ld, dlltool, ..) are called first.

First, make sure that you have working distribution of the native port
of both libsigc++-2.10.x and glib-2.0 on win32 (see
http://www.gimp.org/win32). If you can't compile a simple glib example
using gcc and `pkg-config --cflags --libs`, you should not even think
about trying to compile glibmm, let alone using precompiled libglibmm
DLLs to port your glibmm application !

The configure script can then be called using (as an example) the
following options

./configure --prefix=/target --build=i386-pc-mingw32 --disable-static

then

make
make check
make install

2. MS Visual Studio 2015

In a Visual Studio command prompt, navigate to the MSVC_NMake directory.
Run 'nmake /f Makefile.vc CFG=[release|debug]' to build the glibmm and
giomm DLLs, along with their example programs.  If a prefix other than
$(srcroot)\..\vs$(VSVER)\$(Platform) is desired, pass in PREFIX=$(your_prefix)
in the NMake command line.  In order to build the giomm settings example
program, the glib-compile-schemas needs to reside in $(PREFIX)\bin, or
it must be specified via passing in GLIB_COMPILE_SCHEMAS.  If you are using
C++ dependencies that are built with Meson, specify USE_MESON_LIBS=1 in
your NMake command line.

Note that $(VSVER) refers to 14 for Visual Studio 2015 and 15 for Visual
Studio 2017.

A 'tests' target will build the test programs for glibmm and giomm, an
'install' target is provided to copy the built DLLs and LIBs, along with
with the public headers to appropriate subdirs of $(PREFIX).  A 'clean'
target is also provided to remove all the built files.

The NMake Makefiles now support building the glibmm libraries directly from a GIT checkout
with a few manual steps required, namely to:

-Ensure that you have a copy of Cygwin or MSYS/MSYS64 installed, including
 m4.exe and sh.exe.  You should also have a PERL for Windows installation
 as well, and your PATH should contain the paths to your PERL interpreter
 and the bin\ directory of your Cygwin or MSYS/MSYS64 installation, and
 it is recommended that these paths are towards the end of your PATH.  You need
 to install the XML::Parser PERL module as well, which requires libexpat.

-Make a new copy of the entire source tree to some location, where the build
 is to be done; then in $(srcroot)\MSVC_NMake run
 nmake /f Makefile.vc CFG=[release|debug] prep-git-build, which will copy and generate
 the following files with the proper info (this step may also be needed if the following
 files are not present in the unpacked source tarball):
 --$(srcroot)\MSVC_NMake\glibmm\glibmmconfig.h
 --$(srcroot)\MSVC_NMake\giomm\giommconfig.h
 --$(srcroot)\MSVC_NMake\glibmm\glibmm.rc
 --$(srcroot)\MSVC_NMake\giomm\giomm.rc
 --$(srcroot)\tools\gmmproc
 --$(srcroot)\tools\generate_wrap_init.pl

After copying the above 6 files, you need to ensure that they reflect on the package version
that best matches your checkout status and the paths in $(srcroot)\tools\gmmproc and
$(srcroot)\tools\generate_wrap_init.pl (the items enclosed between the @...@'s) should reflect
on where you intend for nmake /f Makefile.vc CFG=$(CFG) install to install to (i.e. $(PREFIX)).
For giommconfig.h, it is recommended to keep GIOMM_STATIC_LIB and GIOMM_DISABLE_DEPRECATED
undefined unless you know what you are doing (remember, the NMake Makefiles only support DLL
builds out-of-the-box).  For builds from the release tarballs, running
nmake /f Makefile.vc CFG=[release|debug] gen-perl-scripts-real will also generate
$(srcroot)\tools\gmmproc and $(srcroot)\tools\generate_wrap_init.pl for you.

Note that the prep-git-build and the gen-perl-scripts-real targets will require a working PERL
installation.


3. Glibmm methods and signals not available on win32

All glibmm methods and signals are available on win32.