OpenQuizz
Une application de gestion des contenus pédagogiques
config Class Reference
Inheritance diagram for config:
Collaboration diagram for config:

Public Member Functions

def initialize_options (self)
 
def finalize_options (self)
 
def run (self)
 
def try_cpp (self, body=None, headers=None, include_dirs=None, lang="c")
 
def search_cpp (self, pattern, body=None, headers=None, include_dirs=None, lang="c")
 
def try_compile (self, body, headers=None, include_dirs=None, lang="c")
 
def try_link (self, body, headers=None, include_dirs=None, libraries=None, library_dirs=None, lang="c")
 
def try_run (self, body, headers=None, include_dirs=None, libraries=None, library_dirs=None, lang="c")
 
def check_func (self, func, headers=None, include_dirs=None, libraries=None, library_dirs=None, decl=0, call=0)
 
def check_lib (self, library, library_dirs=None, headers=None, include_dirs=None, other_libraries=[])
 
def check_header (self, header, include_dirs=None, library_dirs=None, lang="c")
 

Data Fields

 compiler
 
 cc
 
 include_dirs
 
 libraries
 
 library_dirs
 
 noisy
 
 dump_source
 
 temp_files
 

Static Public Attributes

 description
 
 user_options
 

Member Function Documentation

◆ check_func()

def check_func (   self,
  func,
  headers = None,
  include_dirs = None,
  libraries = None,
  library_dirs = None,
  decl = 0,
  call = 0 
)
Determine if function 'func' is available by constructing a
source file that refers to 'func', and compiles and links it.
If everything succeeds, returns true; otherwise returns false.

The constructed source file starts out by including the header
files listed in 'headers'.  If 'decl' is true, it then declares
'func' (as "int func()"); you probably shouldn't supply 'headers'
and set 'decl' true in the same call, or you might get errors about
a conflicting declarations for 'func'.  Finally, the constructed
'main()' function either references 'func' or (if 'call' is true)
calls it.  'libraries' and 'library_dirs' are used when
linking.

◆ check_header()

def check_header (   self,
  header,
  include_dirs = None,
  library_dirs = None,
  lang = "c" 
)
Determine if the system header file named by 'header_file'
exists and can be found by the preprocessor; return true if so,
false otherwise.

◆ check_lib()

def check_lib (   self,
  library,
  library_dirs = None,
  headers = None,
  include_dirs = None,
  other_libraries = [] 
)
Determine if 'library' is available to be linked against,
without actually checking that any particular symbols are provided
by it.  'headers' will be used in constructing the source file to
be compiled, but the only effect of this is to check if all the
header files listed are available.  Any libraries listed in
'other_libraries' will be included in the link, in case 'library'
has symbols that depend on other libraries.

◆ finalize_options()

def finalize_options (   self)

◆ initialize_options()

def initialize_options (   self)

◆ run()

def run (   self)

◆ search_cpp()

def search_cpp (   self,
  pattern,
  body = None,
  headers = None,
  include_dirs = None,
  lang = "c" 
)
Construct a source file (just like 'try_cpp()'), run it through
the preprocessor, and return true if any line of the output matches
'pattern'.  'pattern' should either be a compiled regex object or a
string containing a regex.  If both 'body' and 'headers' are None,
preprocesses an empty file -- which can be useful to determine the
symbols the preprocessor and compiler set by default.

◆ try_compile()

def try_compile (   self,
  body,
  headers = None,
  include_dirs = None,
  lang = "c" 
)
Try to compile a source file built from 'body' and 'headers'.
Return true on success, false otherwise.

◆ try_cpp()

def try_cpp (   self,
  body = None,
  headers = None,
  include_dirs = None,
  lang = "c" 
)
Construct a source file from 'body' (a string containing lines
of C/C++ code) and 'headers' (a list of header files to include)
and run it through the preprocessor.  Return true if the
preprocessor succeeded, false if there were any errors.
('body' probably isn't of much use, but what the heck.)

◆ try_link()

def try_link (   self,
  body,
  headers = None,
  include_dirs = None,
  libraries = None,
  library_dirs = None,
  lang = "c" 
)
Try to compile and link a source file, built from 'body' and
'headers', to executable form.  Return true on success, false
otherwise.

◆ try_run()

def try_run (   self,
  body,
  headers = None,
  include_dirs = None,
  libraries = None,
  library_dirs = None,
  lang = "c" 
)
Try to compile, link to an executable, and run a program
built from 'body' and 'headers'.  Return true on success, false
otherwise.

Field Documentation

◆ cc

cc

◆ compiler

compiler

◆ description

description
static

◆ dump_source

dump_source

◆ include_dirs

include_dirs

◆ libraries

libraries

◆ library_dirs

library_dirs

◆ noisy

noisy

◆ temp_files

temp_files

◆ user_options

user_options
static

The documentation for this class was generated from the following file: