Difference between revisions of "Developer's Guide"

From CVC4
Jump to: navigation, search
(→‎Source tree layout)
Line 2: Line 2:
  
 
* config
 
* config
 +
** this directory holds m4 macro processor files and bits of the autotools build system
 
* contrib
 
* contrib
 +
** this directory includes maintainer scripts and other things that aren't *directly* part of CVC4
 
* doc
 
* doc
 +
** documentation
 
* src
 
* src
 
** core
 
** core
 +
*** the core of CVC4: the expression package, the core engines, ...
 
** include
 
** include
 +
*** most include files (some private include files are also in parser and sat)
 
** parser
 
** parser
 +
*** parsers for supported CVC4 input formats
 
** sat
 
** sat
 +
*** propositional parts of CVC4; these include imported minisat sources
  
 
=Coding guidelines=
 
=Coding guidelines=

Revision as of 04:14, 17 November 2009

Source tree layout

  • config
    • this directory holds m4 macro processor files and bits of the autotools build system
  • contrib
    • this directory includes maintainer scripts and other things that aren't *directly* part of CVC4
  • doc
    • documentation
  • src
    • core
      • the core of CVC4: the expression package, the core engines, ...
    • include
      • most include files (some private include files are also in parser and sat)
    • parser
      • parsers for supported CVC4 input formats
    • sat
      • propositional parts of CVC4; these include imported minisat sources

Coding guidelines

File and directory names

Source file layout

Class header files

Class implementation files

Imported sources

(make sure to add to update-copyright.pl exclusions list)

Source file headers

update-copyright.pl

Using emacs

cvc4.el

General guidelines

Comments

Whitespace/tabs

Indentation

Use of autotools: automake, autoconf, autoheader, libtool

Retrieved from "http://cvc4.cs.stanford.edu/w/index.php?title=Developer%27s_Guide&oldid=922"