HACKING 21.8 KB
Newer Older
1
2
3
4
Bootstraping from the GIT repository
====================================

(If you are building from a tarball, skip this section.)
5

6
7
8
9
10
11
12
13
Spot's gitlab page is at

  https://gitlab.lrde.epita.fr/spot/spot

The GIT repository can be cloned with

  git clone https://gitlab.lrde.epita.fr/spot/spot.git

14
Some files in SPOT's source tree are generated.  They are distributed
Antoine Martin's avatar
Antoine Martin committed
15
16
17
so that users do not need to install tools to rebuild them, but we
don't keep all of them under GIT because it can generate lots of
changes or conflicts.
18

19
Here are the tools you need to bootstrap the GIT tree, or more
20
generally if you plan to regenerate some of the generated files.
21
22
(None of these tools are required by end users installing a tarball
since the generated files they produce are distributed.)
23

24
  GNU Autoconf >= 2.69
25
  GNU Automake >= 1.11
26
  GNU Libtool >= 2.4
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
27
  GNU Flex >= 2.6
28
  GNU Bison >= 3.0
29
  GNU Emacs (preferably >= 24 but it may work with older versions)
30
31
32
33
  org-mode >= 9.1 (the version that comes bundled with your emacs
    version is likely out-of-date; but distribution often have
    a separate and more recent org-mode package, or you can
    simply upgrade from ELPA).
34
  Groff (a.k.a. GNU troff) >= 1.20
35
36
37
  SWIG >= 3.0.2, preferably >= 4.0.1 (for its better modern C++ support)
    If you use Macports you consider installing the swig-python package
    in addition to the swig package.
38
  Doxygen >= 1.4.0
39
  R   used by some examples in the documentation
40
41
  Perl, with its Gettext module (it might be called something like
    liblocale-gettext-perl or p5-locale-gettext in your distribution)
42
43
  A complete LaTeX distribution, including latexmk and extra fonts
    like dsfont.sty.
Etienne Renault's avatar
Etienne Renault committed
44
  ImageMagick
45
  Python >= 3.5, IPython >= 2.3
46
  Jupyter >= 4, with nbconvert
47
  GraphViz
48
  Java >= 1.7 (needed to run PlantUML while generating the doc)
49
  wget or curl (needed to download PlantUML)
50
  pdf2svg
51
52
53
54
55
56

The following additional tools are used if they are present, or
only for certain operations (like releases):

  pandoc    used during Debian packaging for the conversion of
            IPython notebooks to html
57
58
  svgo      for reducing SVG images before generating the tarball
            (install with: npm install -g svgo)
59
60
61
62
  ltl2ba    used in the generated documentation and the test suite
  ltl2dstar likewise
  ltl3dra   likewise
  spin      likewise
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
63
  dot2tex   used for an example in the documentation and in one test
64
65
66
67
68
69
70
71
72
73
74
  glucose >= 3.0  likewise
  lbtt >= 1.2.1a  used in the test suite (ltlcross is now more
            powerful, but additional tests do not hurt)

If you use Debian or a similar distribution, the Dockerfile at
https://github.com/adl/spot-docker/blob/master/debuild/Dockerfile
lists all the Debian packages that should be installed to build
Debian packages out of the GIT tree.  Additionally, the script
https://github.com/adl/spot-docker/blob/master/debuild/install.sh
installs the third-party tools that do not have Debian packages.

75

76
Bootstrap the GIT tree by running
77

78
  % autoreconf -vfi
79

80
and then go on with the usual
81

82
83
  % ./configure
  % make
84

85

86
87
88
Tricks
======

89
90
91
92
93
94
Avoiding org-mode runs
----------------------

The files in doc/org/ are org-mode files (a mode of Emacs that we use
to author documents that embed executable snippets), they are used to
generate the doc/userdoc/ HTML documentation.  If for some reason you
95
don't have emacs, or you simply want not to rebuild these files, use:
96

97
  % touch doc/org-stamp
98

99

100
101
102
103
Silent Building with automake
-----------------------------

The classical makefiles generated by automake are very verbose during
104
105
106
107
build beacause they print the full command line of every stage.  This
verbosity is very usefull to help (remotely) users to compile Spot.
Nonetheless, these compilations lines may be annoying for some
developers.  To reduce this verbosity, just run:
108

109
  % make V=0
110

111
112
113
114
115

Executing a single test
-----------------------

All tests in subdirectories of tests/ are executed through the
116
117
tests/run script.  That script defines PATH and other environment
variables necessary so that shell and Python scripts will use the
118
119
120
version of Spot under development.  For instance to execute
tests/core/acc.test, do:

121
122
  % cd tests
  % ./run core/acc.test
123
124
125
126
127
128
129
130
131
132
133
134

A test run this way automatically executes in verbose mode.  Any
temporary file generated by the script can be found in
tests/core/acc.dir/.

Alternatively, if you use emacs, the .dir-locals.el configuration at
the top of the project redefines the C-c C-c key for all shell and
python scripts under the tests/ directory.  So if you are working on
tests/core/acc.test under emacs, hitting C-c C-c should be all you
need to execute it.


135
136
137
Debugging Libtool executables
-----------------------------

138
The executables generated in the various testsuite directories of Spot
139
are not real binaries.  Because we use libtool to compile the spot
140
141
library in a portable manner, these executables are just scripts that
run the actual binary after setting some environment variables so that
142
143
the OS can find the library in the build tree.

144
145
A consequence is that tools like gdb or valgrind, that expect to work
on a binary, will be confused by the script.  Example:
146

147
  % cd bin
148
149
150
  % file ltl2tgba
  ltl2tgba: POSIX shell script text executable
  % gdb -q ltl2tgba
151
  "/home/adl/git/spot/bin/ltl2tgba/ltl2tgba": not in executable format: File format not recognized
152
153
  (gdb) quit

154
155
The proper way to run any command on these fake binaries is via
libtool:
156

157
  % ../libtool --mode=execute file ltl2tgba
158
  /home/adl/git/spot/bin/.libs/lt-ltl2tgba: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), dynamically linked (uses shared libs), for GNU/Linux 2.6.18, not stripped
159
  % ../libtool --mode=execute gdb -q ltl2tgba
160
  Reading symbols from /home/adl/git/spot/bin/.libs/lt-ltl2tgba...done.
161
162
  (gdb) quit

163
164
165
166
167
You can see that libtool turns ltl2tgba into .libs/lt-ltl2tgba, but it
also sets environment variables so that the dependent shared libraries
will be found.

If you are building Spot from the GIT repository, the libtool script
168
169
generated the root of the build tree should be the same as the libtool
script that is installed on your system.  So you can simply run
170
libtool instead of ../libtool.
171

172
There is an undocumented feature of libtool that allows you to
173
shorthand "libtool --mode=execute" as "libtool execute" or even
174
175
176
177
178
179
180
181
"libtool e".  But you might also find convenient to define an alias, a
function, or a script to make that invocation even shorter.
For instance:

  alias le='libtool --mode=execute '

(The trailing space makes it possible to follow this command by
another aliased command.)
182

183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
If you are using MacOS, the installation of GDB can be hard, even when
using packages manager like MacPorts or Homebrew. Indeed Apple promotes
lldb over gdb.

A consequence the following command lines work perfectly on
pre El Capitan (OS X 10.11) versions

   % ../libtool --mode=execute lldb --  bin/ltl2tgba
   (lldb) r 'F a'

Nonetheless for newer versions the same commands will (probably)
raise:

   dyld: Library not loaded: /usr/local/lib/libspot.0.dylib
      Referenced from: /Users/etienne/src/spot/bin/.libs/ltl2tgba
      Reason: image not found
      Process 11024 stopped

This is a side effect of "System Integrity Protection" introduced in El
Capitan. From this version, calling tools from /usr/bin purges environment
variables. Consequently the DYLD_LIBRARY_PATH is not exported. Two solutions
can be envisaged:
    - [not-recommended] disable "System Integrity Protection"
    - [recommended]     use the XCode lldb, not located in /usr/bin.

Then, to use lldb on MacOs, just run the following command:
   % ../libtool --mode=execute /Applications/Xcode.app/Contents/Developer/usr/bin/lldb  --  bin/ltl2tgba
   (lldb) r 'F a'

212

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
Profiling with callgrind
------------------------

Install valgrind and kcachegrind.

Then run the command you want to profile through valgrind's callgrind
tool.  For instance:

  % libtool e valgrind --tool=callgrind ltl2tgba -f 'GFa & GFb'

This will output a file called 'callgrind.PID' where PID is the
process ID printed during valgrind's run.  Load this file with
kcachegrind to get a graphical summary.

  % kcachegrind ./callgrind.PID


230
231
232
233
234
Running coverage tests
----------------------

First, compile (and link) Spot with coverage enabled.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
235
  % ./configure CXX='g++ --coverage'
236
237
238
239
240
241
242
243
244
  % make

Then run the test suite (or any program you want to study).

  % make check

Executing programs using Spot will generate a lot of *.gc* files
everywhere.  Collect these using lcov:

Etienne Renault's avatar
Etienne Renault committed
245
  % lcov --capture --directory spot --output spot.info
246
247
248
249
250
251
252

Finally generate a coverage report in HTML:

  % genhtml --legend --demangle-cpp --output-directory html spot.info

This should create the directory html/.

253
254
255
256
Coverage tests are automatically performed by our continuous
integration builds.  You can find a report for each branch in the
artifacts of the debian-unstable-gcc-coverage job.

257

258
259
260
Link-time optimizations
-----------------------

261
262
This used to be bit tricky to setup, but is now quite well supported.
Our Debian packages are built with link-time optimization.
263
264

You need:
265
  1. a version of GCC (>= 4.9) with gold and pluging linker enabled.
266
  2. a version of Libtool that knows how to deal with
267
     -flto flags (Libtool 2.4.2 will work)
268

269
270
Here are example options to pass to configure to build a static
version with link-time optimization:
271

272
  ./configure CC=gcc-4.9 CXX=g++-4.9 \
273
274
275
              --disable-devel --disable-debug \
              CFLAGS='-flto' CXXFLAGS='-flto' LDFLAGS='-fuse-linker-plugin' \
              --disable-shared --enable-static
276

277
278
If you want to build a shared library, see in debian/rules how it is
done.
279
280


281
282
283
284
285
Log driver for testsuite
------------------------

The PASS/FAIL status for each test of the testsuite is printed by
tools/test-driver.  This script can be changed to format the output
286
287
288
differently.  In the past, when we used teamcity (for continuous
integration) we changed the output format to something that teamcity
would understand with:
289

290
  make check LOG_DRIVER=$PWD/tools/test-driver-teamcity
291
292


293
294
Coding conventions
==================
295

296
Here some of the conventions we follow in Spot, so that the code looks
297
298
299
300
301
302
homogeneous.  Please follow these strictly.  Since this is free
software, uniformity of the code matters a lot.  Most of these
conventions are derived from the GNU Coding Standards
(http://www.gnu.org/prep/standards.html) with the notable exception
that we do not put a space before the opening parenthesis in function
calls (this is hardly readable when chaining method calls).
303

304
305
306
Besides cosmetics, some of these conventions are also here
to prevent bugs and make it easier to devise safety checks.

307
The directory tests/sanity/ contains some scripts that are executed
308
309
310
311
312
313
314
315
316
during 'make check' or 'make installcheck' to check some of the
conventions discussed below.

For instance we have a check to ensure that any header can be included
twice, and we have another check to ensure that any header contains a
include guard that follow our naming convention.  This way we do not
forget guards, and we do not forget to rename them when a file is
copied into another one.

317

318
C++17
319
320
-----

321
322
323
324
325
326
327
328
329
330
331
332
  Spot uses some C++17 features, and therefore requires a C++17
  compiler.  g++ 7.x or clang++ 5 should be enough.

  Note that the current stable release, 2.9.x, is still using C++14,
  so avoid rewriting the code base into C++17 just because it's nicer,
  as it will make harder to backport bug fixes.  Feel free to
  introduce C++17 feature in new code, or in algorithms that are
  largely rewritten.

  We currently avoid C++20 features until C++20 compiler are widely
  available.  (FYI: we switched to C++11 in 2015, to C++14 in 2017,
  and to C++17 in 2020.)
333

334

335
336
337
338
339
Encoding
--------

  * Use UTF-8 for non-ASCII characters.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
340
341
342
  * Do not use tabs for indentation in C++ files.  Use only space to
    prevent issues with people assuming different tab widths.

343
344
  * If you edit files encoded in Latin-1 (the original default
    encoding for the project), feel free to convert them to UTF-8.
345
346
    In emacs the simplest way to convert the file is to add a comment
    with -*- coding: utf-8 -*- at the top or bottom of the file.
347

348
349
350
351
    There is some check in tests/sanity/ that will ensure that -*-
    coding: utf-8 -*- is used for all C++ files, but try to use it for
    all text files if they contain non-ascii characters.

352
353
354
355
356
357
358
359
360
361
Includes
--------

  * Use #include with angle-brackets to refer to public headers
    of Spot; i.e., those that will be installed, or system
    headers that are already installed.  E.g.,

    #include <spot/misc/version.hh>
    #include <iostream>

362
363
364
  * Use #include with double quotes to refer to private headers that
    are distributed with Spot.  Those can be from Spot itself, or from
    third-party libraries that we ship.  E.g.,
365

366
    #include "config.h"
367
368
369
370
371
    #include "utf8/utf8.hh"
    #include "spot/priv/trim.hh"

    This style of #include should never occur in public headers.

372
373
374
375
  * "config.h" should be the first file included by any *.cc or *.c
    file, as it setups several macros for replacing missing functions.


376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
Exporting symbols
-----------------

  Since we are building a library, it is important to make a clear
  distinction between what is private and what is public.  In our
  setup, everything is private by default and has to be explicitely
  made public.

  * If a private symbol is needed only by one module, keep it inside
    the *.cc file, in an anonymous namespace.  Also mark it as static
    if it is a function or variable.  This is the best way to let the
    compiler and linker know that the symbol is not used elsewhere.

  * If a symbol could be used by several modules of the library but
    should still be private to the library, use a *.hh/*.cc pair of
    files, but list both files in the _SOURCES variable of that
Etienne Renault's avatar
Etienne Renault committed
392
    directory (see for instance weight.hh in priv/Makefile.am).
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
393
394
    This will ensure that the header is not installed.
    Needless to say, no public header should include such a private
395
396
    header.

Etienne Renault's avatar
Etienne Renault committed
397
  * The directory spot/priv/ can be used to store files that are
Clément Gillard's avatar
Clément Gillard committed
398
    globaly private to the library, and that do not really belong to
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
399
    other directories.
400
401
402

  * Functions and classes that are public should be marked with
    the SPOT_API macro.  This macro is defined in misc/common.hh,
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
403
    but you need not include it in a file that already includes
404
405
406
407
408
    another public header.

  * Do not make a symbol public just because you can.

  * Read http://www.akkadia.org/drepper/dsohowto.pdf for more
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
409
    information about how shared libraries work and why.
410

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
Assertions
----------

  * There are different types of assertions.  Plain assert() is OK for
    invariants or post-conditions.  When asserting a pre-condition,
    carefully consider who the caller might be: if it can be in
    user-code (either in C++ or Python), throw an exception
    (std::runtime_error, std::invalid_argument, and spot::parse_error
    are the three exception types catched by the Python bindings).

  * Do not call assert() in public *.hh files: even if the installed
    libspot has been compiled with -DNDEBUG, the *.hh files will be
    recompiled by users, probably without -DNDEBUG.  So use
    SPOT_ASSERT() instead of assert(), this ensure asserts are only
    used inside libspot for debug builds.

427
428
429
Comments
--------

430
  * The language to use is American English.
431
432
433
434
435

  * When comments are sentences, they should start with a capital and
    end with a dot.  Dots that end sentences should be followed by two
    spaces (i.e., American typing convention), like in this paragraph.

436
437
438
  * Prefer C++-style comments (// foo) to C-style comments (/* foo */).
    Use /// for Doxygen comments.

439
440
441
442
443
444
445
  * When mentioning an issue number, in comments as well as in commit
    messages, use one of the following forms so that we can configure
    our editors to turn these into hyperlinks.

       Issue #123 / issue #123 / Fixes #123 / fixes #123

    (When gitlab sees a commit message containing "Fixes #123" or
446
447
448
    "fixes #123" pushed to branch "next", it should automatically
    close the issue.  But these days, it does not seem to work and
    often require manual closing.)
449

450
451
452
Formating
---------

453
454
  * Braces around instruction blocks are always on their own line.
    Braces around initializers lists need not be on their own.
455
456
457
458
459

  * Text within braces is two-space indented.

    {
      f(12);
460

461
462
463
464
465
466
467
468
469
470
471
472
    }

  * Anything after a control statement is two-space indented.  This
    includes braces.

    if (test)
      {
        f(123);
	while (test2)
	  g(456);
      }

473
  * Braces from function/structure/enum/class/namespace definitions
474
475
476
477
478
479
480
481
482
483
484
    are not indented.

    class foo
    {
    public:
      Foo();
    protected:
      static int get_mumble();
    };

  * The above corresponds to the `gnu' indentation style under Emacs.
485
486

  * Put a space before the opening parenthesis in control statements
487
488
489
490
491
492
493
494
495
496
497
498

    if (test)
      {
        do
	  {
	    something();
	  }
	while (0);
      }

  * No space before parentheses in function calls.
    (`some()->foo()->bar()' is far more readable than
499
    `some ()->foo ()->bar ()')
500
501
502

  * No space after opening or before closing parentheses, however
    put a space after commas (as in english).
503

504
    func(arg1, arg2, arg3);
505

506
507
508
509
510
511
512
513
514
  * No useless parentheses in return statements.

    return 2;    (not `return (2);')

  * Spaces around infix binary or ternary operators:

    2 + 2;
    a = b;
    a <<= (3 + 5) * 3 + f(67 + (really ? 45 : 0));
515

Alexandre Duret-Lutz's avatar
typo    
Alexandre Duret-Lutz committed
516
517
  * No space after prefix unary operators, or before postfix unary
    operators:
518
519
520
521
522
523

    if (!test && y++ != 0)
      {
        ++x;
      }

524
525
526
  * When an expression spans over several lines, prefer splitting it
    before operators.  If it's inside a parenthesis, the following
    lines should be 1-indented w.r.t. the opening parenthesis.
527
528
529
530
531
532
533

    if (foo_this_is_long && bar > win(x, y, z)
        && !remaining_condition)
      {
        ...
      }

534
535
  * `else if' can be put as-is on a single line.

536
537
  * No line should be larger than 80 columns.
    If a line takes more than 80 columns, split it or rethink it.
538

539
540
541
542
543
544
545
546
547
    This makes it easier to print the code, allow people to work on
    small screens, makes it possible to display two files (or an
    editor and a terminal) side-by-side, ...

    This also puts some pressure on the programmer who writes code
    that has too much nested blocks: if you find yourself having to
    code between columns 60 and 80 because of identation, consider
    writing helper functions to simplify the structure of your code.

548
  * Labels or case statements are back-indented by two spaces,
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
549
    without space before the `:'.
550

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
    if (something)
      {
      top:
        bar = foo();
        switch (something_else)
	  {
	  case first_case:
	    f();
	    break;
	  case second_case:
	    g();
	    break;
	  default:
	    goto top;
	  }
      }

568
569
570
571
572
573
574
575
576
577
578
579
580
  * Pointers and references are part of the type, and should be put
    near the type, not near the variable.

      int* p;        // not `int *p;'
      list& l;       // not `list &l;'
      void* magic(); // not `void *magic();'

  * Do not declare many variables on one line.
    Use
      int* p;
      int* q;
    instead of
      int *p, *q;
581
    The former declarations also allow you to comment each variable.
582

Etienne Renault's avatar
Etienne Renault committed
583
  * The include guard for spot/somedir/foo.hh is
584
585
    SPOT_SOMEDIR_FOO_HH

586
Naming
587
------
588
589
590
591
592
593
594

  * Functions, methods, types, classes, etc. are named with lowercase
    letters, using an underscore to separate words.

      int compute_this_and_that();

      class this_is_a_class;
595

596
597
598
599
      typedef int int_array[];

    That is the style used in STL.

600
  * Private members end with an underscore.
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621

    class my_class
    {
    public:
      ...
      int get_val() const;
    private:
      int name_;
    };

  * Identifiers (even internal) starting with `_' are best avoided
    to limit clashes with system definitions.

  * Template arguments use capitalized name, with joined words.

    template <class T, int NumberOfThings>
    class foo
    {
      ...
    };

622
  * Enum members also use capitalized name, with joined words.
623
624
625

  * C Macros are all uppercase.

626
627
  * Use *.hxx for the implementation of templates that are private to
    Spot (i.e., not installed) and need to be included multiple times.
628

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
SPOT macros
-----------

  A few macros are defined in misc/common.hh notably:

  * SPOT_FALLTHROUGH should be used to mark fall-throughs in switches:

     switch (foo)
     {
       case 1:
         f();
         SPOT_FALLTHROUGH;
       case 2:
         g();
         break;
     }

  * Use SPOT_UNREACHABLE() to mark places that are not reachable but
    that a compiler might not see as unreachable.

  * Use SPOT_API in front of functions and class that should be
650
    exported by the shared library.  See "Exporting symbols" above.
651
652
653
654
655

  * Use SPOT_ASSERT(...) if you ever have to put an assertion in
    some header file.  See "Assertions" above.

  * Use SPOT_LIKELY / SPOT_UNLIKELY in case you need to help the
Antoine Martin's avatar
Antoine Martin committed
656
    compiler figure out the common output of a test.  Do not abuse
657
658
659
    this without checking the assembly output to make sure the effect
    is what you desired.

660
Other style recommandations
661
---------------------------
662

663
664
  * The original C++98 code used 0 for null pointers (and never NULL).
    Feel free to replace these by uses of C++11's nullptr instead.
665

666
  * Limit the scope of local variables by defining them as late as
Antoine Martin's avatar
Antoine Martin committed
667
    possible.  Do not reuse a local variable for two different things.
668

669
  * Do not systematically initialize local variables with 0 or other
670
    meaningless values.  This hides errors to valgrind.
671
672
673

  * Avoid <iostream>, <ostream>, etc. in headers whenever possible.
    Prefer <iosfwd> when predeclarations are sufficient, and then
674
    for instance use just <ostream> in the corresponding .cc file.
675
    (A plain <iostream> is needed when using std::cout, std::cerr, etc.)
676
677
678
679
680
681

  * Always declare helper functions and other local class definitions
    (used in a single .cc files) in anonymous namespaces.  (The risk
    otherwise is to declare two classes with the same name: the linker
    will ignore one of the two silently.  The resulting bugs are often
    difficult to understand.)
682
683
684

  * Always code as if the person who ends up maintaining your code is
    a violent psychopath who knows where you live.