Makefile.conf
author Volker Birk <vb@pep-project.org>
Wed, 21 Aug 2019 11:04:05 +0200
branchENGINE-325
changeset 4003 572e950593dc
parent 3580 7c757957849b
child 4028 5d9532df8f5c
permissions -rw-r--r--
adding features
     1 # Copyright 2017, pEp Foundation
     2 # This file is part of pEpEngine
     3 # This file may be used under the terms of the GNU General Public License version 3
     4 # see LICENSE.txt
     5 
     6 # See `doc/build-<your platform>.md` for documentation on how to build, and customize your build.
     7 
     8 # This file sets all the make variables that allow you to customize a build.
     9 # There are 3 ways in which you can customize your build:
    10 # 1) Edit the variable assignments in this file (this is a tracked file, so your repository will be dirty)
    11 # 2) Create `local.conf` and fill it with variable assignments.
    12 # 3) Set the environment variable `BUILD_CONFIG` to an absolute path.
    13 #    The variable assignments found in the make file at the path indicated by `BUILD_CONFIG` will be evaluated.
    14 # Customization options are applied in the order given above. Later variable assignments take precedence over earlier ones.
    15 # It is possible to use multiple variants simultaniously.
    16 # If nothing is changed according to these 3 methods, a default configuration for your platform (specified below) will be used for the build.
    17 
    18 
    19 ######### Header #########
    20 HERE:=$(dir $(lastword $(MAKEFILE_LIST)))
    21 
    22 
    23 ######### General #########
    24 # To use (only) system libraries, set all the *_INC and *_LIB variables to the empty string.
    25 # All the *_INC and *_LIB variables are command line flags, not paths.
    26 # Thus, all *_INC variables' values must start with "-I", and all *_LIB variables' values must start with "-L".
    27 
    28 BUILD_ON:=$(shell uname)
    29 
    30 # This variable specifies the platform that the engine should be cross-compiled for.
    31 BUILD_FOR=$(BUILD_ON)
    32 
    33 # Cross-compiling is currently not supported.
    34 # Maybe you can hack something with `local.conf`.
    35 ifneq ($(BUILD_ON),$(BUILD_FOR))
    36     $(error I don't know how to build for $(BUILD_FOR) on $(BUILD_ON).)
    37 endif
    38 
    39 # Installation path prefix for libraries and binaries, except for system.db
    40 PREFIX=$(HOME)
    41 
    42 # pEp files and directories
    43 #
    44 # the PER_USER_DIRECTORY will be in $(HOME), respectively
    45 # in debug builds the PER_USER_DIRECTORY will be in $(PEP_HOME) instead if set
    46 #
    47 # PER_MACHINE_DIRECTORY is calculated depending on platform; overwrite if
    48 # necessary
    49 
    50 #PER_USER_DIRECTORY=.pEp
    51 #PER_MACHINE_DIRECTORY=/usr/local/share/pEp
    52 
    53 # Filename of the pEpEngine library
    54 ifeq ($(BUILD_FOR),Linux)
    55     TARGET=libpEpEngine.so
    56 else ifeq ($(BUILD_FOR),Darwin)
    57     TARGET=libpEpEngine.dylib
    58 endif
    59 
    60 # If empty, create a release build.
    61 # Otherwise, create a debug build.
    62 # This variable is ineffective when set anywhere else but here.
    63 DEBUG=placeholder
    64 
    65 # If empty, suppress compiler warnings.
    66 # Otherwise, print warnings.
    67 # This variable is ineffective when set anywhere else but here.
    68 WARN=placeholder
    69 
    70 
    71 ######### C and C++ #########
    72 TARGET_ARCH=
    73 
    74 # The following two variables will be appended to.
    75 # You can thus not set them to a final, fixed value here.
    76 ifeq ($(BUILD_FOR),Linux)
    77     LDFLAGS=
    78 else ifeq ($(BUILD_FOR),Darwin)
    79     # "-bind_at_load" helps find symbol resolution errors faster
    80     LDFLAGS=-bind_at_load
    81 endif
    82 
    83 LDLIBS=
    84 
    85 
    86 ######### C #########
    87 ifeq ($(BUILD_FOR),Linux)
    88     CC=gcc -std=c99 -pthread
    89 else ifeq ($(BUILD_FOR),Darwin)
    90     # clang issues a warning when "-pthread" is used for linking.
    91     # So, include it in CFLAGS, and not in CC
    92     CC=clang -std=c99
    93 endif
    94 
    95 ifeq ($(BUILD_FOR),Linux)
    96     CFLAGS=-fPIC -fstrict-aliasing -fdiagnostics-color=always
    97 else ifeq ($(BUILD_FOR),Darwin)
    98     CFLAGS=-pthread -fPIC -fstrict-aliasing -fcolor-diagnostics
    99 endif
   100 
   101 # The flag -DNDEBUG will always be removed from CFLAGS for compiling tests.
   102 # The tests do not work properly, if compiled with -DNDEBUG
   103 ifeq ($(BUILD_FOR),Linux)
   104     ifdef WARN
   105         CFLAGS+= -Wall -pedantic -Wstrict-aliasing=3
   106     else
   107         CFLAGS+= -w
   108     endif
   109     ifdef DEBUG
   110         CFLAGS+= -g -ggdb -DDEBUG_ERRORSTACK
   111     else
   112         CFLAGS+= -O3 -DNDEBUG
   113     endif
   114 else ifeq ($(BUILD_FOR),Darwin)
   115     ifdef WARN
   116         # FIXME Remove 'no-extended-offsetof' after ENGINE-236 is closed.
   117         CFLAGS+= -Wall -pedantic -Wno-extended-offsetof
   118     else
   119         CFLAGS+= -w
   120     endif
   121     ifdef DEBUG
   122         CFLAGS+= -O0 -g -DDEBUG_ERRORSTACK
   123     else
   124         CFLAGS+= -O3 -DNDEBUG
   125     endif
   126 endif
   127 
   128 # Additional CFLAGS used for compiling ASN1C-generated code
   129 ifeq ($(BUILD_FOR),Linux)
   130     # The '_DEFAULT_SOURCE' feature test macro is required to suppress the warning
   131     #   _BSD_SOURCE and _SVID_SOURCE are deprecated, use _DEFAULT_SOURCE
   132     # otherwise printed during the compilation of every asn1c-generated C file.
   133     # It's a glibc specific warning, only present in few versions around ~2.19.
   134     # See https://lwn.net/Articles/590381/ for a discussion.
   135     CFLAGS_GENERATED=-D_DEFAULT_SOURCE
   136 else ifeq ($(BUILD_FOR),Darwin)
   137     CFLAGS_GENERATED=
   138 endif
   139 
   140 
   141 ######### C++ #########
   142 ifeq ($(BUILD_FOR),Linux)
   143     CXX=g++ -std=gnu++11 -pthread
   144 else ifeq ($(BUILD_FOR),Darwin)
   145     # clang issues a warning when "-pthread" is used for linking. So, include it in CXXFLAGS, and not in CXX
   146     CXX=clang -std=c++11
   147 endif
   148 
   149 # The flag -DNDEBUG will always be removed from CXXFLAGS for compiling tests.
   150 # The tests do not work properly, if compiled with -DNDEBUG
   151 ifeq ($(BUILD_FOR),Linux)
   152     CXXFLAGS=-fdiagnostics-color=always -I../src -I../asn.1 $(ETPAN_INC)
   153     ifdef WARN
   154         CXXFLAGS+=
   155     else
   156         CXXFLAGS+= -w
   157     endif
   158     ifdef DEBUG
   159         CXXFLAGS+= -g -ggdb
   160     else
   161         CXXFLAGS+= -O3 -DNDEBUG
   162     endif
   163 else ifeq ($(BUILD_FOR),Darwin)
   164     CXXFLAGS=-pthread -fcolor-diagnostics -I../src -I../asn.1 $(ETPAN_INC)
   165     ifdef WARN
   166         CXXFLAGS+=
   167     else
   168         CXXFLAGS+= -w
   169     endif
   170     ifdef DEBUG
   171         CXXFLAGS+= -O0 -g
   172     else
   173         CXXFLAGS+= -O3 -DNDEBUG
   174     endif
   175 endif
   176 
   177 
   178 ######### C and C++ #########
   179 CPPFLAGS=
   180 
   181 
   182 ######### YML2 #########
   183 YML2_PATH=$(HOME)/yml2
   184 
   185 YML2_PROC=$(YML2_PATH)/yml2proc $(YML2_OPTS)
   186 
   187 YML2_OPTS=--encoding=utf8
   188 
   189 
   190 ######### asn1c #########
   191 # asn1c binary
   192 ASN1C=asn1c
   193 
   194 # asn1c include search flag
   195 ASN1C_INC=
   196 #ASN1C_INC=-I$(HOME)/include
   197 
   198 
   199 ######### libetpan #########
   200 # libetpan library search flag
   201 ETPAN_LIB=
   202 #ETPAN_LIB=-L$(HOME)/lib
   203 
   204 # libetpan include search flag
   205 ETPAN_INC=
   206 #ETPAN_INC=-I$(HOME)/include
   207 
   208 
   209 ######### pEp MIME #########
   210 # set this to skip libetpan and use PEP_MIME instead
   211 # PEP_MIME=1
   212 #
   213 # pEp MIME library search flag
   214 PEP_MIME_LIB=
   215 # pEp MIME include search flag
   216 PEP_MIME_INC=
   217 
   218 
   219 ######### sqlite3 #########
   220 # If empty (or undefined), compile sqlite3 from the sources shipped with the pEp distribution.
   221 # Otherwise, use an sqlite3 implementation found in the OS's include/library paths.
   222 SQLITE3_FROM_OS=placeholder
   223 
   224 
   225 ######### OpenPGP #########
   226 # Path of GPG binary
   227 # gpgconf is not available for old version of GPG, for example GPG 2.0.30. Override this variable, if you compile the engine for such an old version.
   228 GPG_CMD:=$(shell gpgconf --list-components | awk -F: '/^gpg:/ { print $$3; exit 0; }')
   229 
   230 # Selects OpenPGP implementation. must be either `SEQUOIA`, `GPG` or `NETPGP`
   231 OPENPGP=GPG
   232 
   233 # Sequoia-specific variables
   234 SEQUOIA_CFLAGS=
   235 SEQUOIA_LDFLAGS=
   236 SEQUOIA_LIB=
   237 SEQUOIA_INC=
   238 
   239 # libGPGME filename
   240 ifeq ($(BUILD_FOR),Linux)
   241     LIBGPGME=libgpgme.so.11
   242 else ifeq ($(BUILD_FOR),Darwin)
   243     LIBGPGME=libgpgme.11.dylib
   244 endif
   245 
   246 # libGPGME library search flag
   247 GPGME_LIB=
   248 #GPGME_LIB=-L$(HOME)/lib
   249 
   250 # libGPGME include search flag
   251 GPGME_INC=
   252 #GPGME_INC=-I$(HOME)/include
   253 
   254 # NETPGP library search flag
   255 NETPGP_LIB=
   256 #NETPGP_LIB=-L$(HOME)/lib
   257 
   258 # libGPGME include search flag
   259 NETPGP_INC=
   260 #NETPGP_INC=-I$(HOME)/include
   261 
   262 
   263 
   264 ######### CppUnit #########
   265 # CppUnit library search flag
   266 CPPUNIT_LIB=
   267 #CPPUNIT_LIB=-L$(HOME)/local/lib
   268 
   269 # CppUnit include search flag
   270 CPPUNIT_INC=
   271 #CPPUNIT_INC=-I$(HOME)/local/inc
   272 
   273 
   274 ######### Engine internals #########
   275 # C macros (not environment variables) that can be overridden:
   276 # DEFAULT_KEYSERVER - string with default keyserver
   277 # CRASHDUMP_DEFAULT_LINES - number of log lines to deliver for crashdumps
   278 # Example:
   279 #    EXTRA_MACROS=-DDEFAULT_KEYSERVER=\"default-server.org\" -DCRASHDUMP_DEFAULT_LINES=23
   280 EXTRA_MACROS=
   281 
   282 
   283 ######### Misc #########
   284 # FIXME Maybe include these variables here.
   285 # Check how they are used throughout the project before setting them here
   286 #LLDB_BIN
   287 
   288 # Add this for running tests in debugger
   289 #TEST_DEBUGGER=lldb --batch -o r
   290 
   291 # comma-separated list of tests to exclude from gensuite (relevant for running tests only)
   292 EXCLUDE=
   293 
   294 
   295 ######### Footer #########
   296 -include $(HERE)/local.conf
   297 
   298 ifdef BUILD_CONFIG
   299     include $(BUILD_CONFIG)
   300 endif
   301 
   302 ######### Post processing assignments ########
   303 # These variables are ineffective when set anywhere else but here.
   304 ifeq ($(OPENPGP),SEQUOIA)
   305     SEQUOIA_CFLAGS=$(shell pkg-config --cflags-only-other sequoia-openpgp)
   306     SEQUOIA_LDFLAGS=$(shell pkg-config --libs-only-l --libs-only-other sequoia-openpgp)
   307     SEQUOIA_LIB=$(shell pkg-config --libs-only-L sequoia-openpgp)
   308     SEQUOIA_INC=$(shell pkg-config --cflags-only-I sequoia-openpgp)
   309     CFLAGS+= $(SEQUOIA_CFLAGS)
   310     LD_FLAGS+= $(SEQUOIA_LDFLAGS)
   311 endif
   312 
   313 # YML_PATH is needed in the environment of every call to a program of the YML2 distribution
   314 export YML_PATH=$(YML2_PATH)