Example #1
0
    def __init__(self,
                 filename,
                 namespaces=(),
                 compiler_options=None,
                 includes=(),
                 parse_all_comments=False,
                 libclang_location=None):
        """
           Parse the file at construction
           
           Parameters
           -----------

           filename : string
                      Name of the file to parse
           
           namespaces : list of string 
                      Restrict the generation to the given namespaces.
           
           includes         : string, optional
                      Additional includes to add (-I xxx) for clang
           
           compiler_options : string, optional 
                      Additional option for clang compiler
           
           libclang_location : string, optional
                      Absolute path to libclang. By default, the detected one.
        """
        self.filename, self.namespaces = filename, namespaces
        self.root = CL.parse(filename, compiler_options, includes,
                             libclang_location, parse_all_comments)
Example #2
0
    def __init__(self, filename, namespaces=(), compiler_options=None, includes = None, system_includes = None, libclang_location = None, parse_all_comments = False, target_file_only = False):
        """
           Parse the file at construction
           
           Parameters
           -----------

           filename : string
                      Name of the file to parse
           
           namespaces : list of string 
                      Restrict the generation to the given namespaces.
           
           includes : string, optional
                      Additional includes to add (-I xxx) for clang

           system_includes : string, optional
                      Additional System includes to add (-isystem xxx) for clang
           
           compiler_options : string, optional 
                      Additional option for clang compiler
           
           libclang_location : string, optional
                      Absolute path to libclang. By default, the detected one.

           parse_all_comments : bool
                      Grab all comments, including non doxygen like [default = False]

           target_file_only : bool
                      Neglect any included files during desc generation [default = False]
        """
        self.filename, self.namespaces, self.target_file_only = filename, namespaces, target_file_only
        self.root = CL.parse(filename, compiler_options, includes, system_includes, libclang_location, parse_all_comments, skip_function_bodies = False)
Example #3
0
    def __init__(self, filename, namespaces=(), classes= (), namespace_to_factor= (), appname= '', 
                 modulename = '', moduledoc ='', use_properties = False, members_read_only = True,  converters = (),
                 compiler_options=None, includes= None, system_includes= None, libclang_location = None, shell_command = '', parse_all_comments = True, target_file_only = False):
        """
           Parse the file at construction
           
           Parameters
           -----------

           filename : string
                      Name of the file to parse
           
           namespaces : list of string 
                      Restrict the generation to the given namespaces.
           
           classes : list of string
                      Restrict the generation to the given classes.
           
           appname  : string
                      Name of the application
           
           modulename : string
                      Name of the module
           
           moduledoc : string
                      Documentation of the module

           shell_command : string
                      script command that was called (to regenerate the desc file)

           use_properties : Boolean
                      Transform method with no args into property

           members_read_only : Boolean
                      The members are wrapped "read only"

           includes : string, optional
                      Additional includes to add (-I xxx) for clang

           system_includes : string, optional
                      Additional System includes to add (-isystem xxx) for clang
           
           compiler_options : string, optional 
                      Additional option for clang compiler
           
           libclang_location : string, optional
                      Absolute path to libclang. By default, the detected one.

           parse_all_comments : bool
                      Grab all comments, including non doxygen like [default = True]

           target_file_only : bool
                      Neglect any included files during desc generation [default = False]
        """
        for x in ['filename', 'namespaces', 'classes', 'namespace_to_factor', 'appname', 'modulename', 'moduledoc', 
                  'use_properties', 'members_read_only', 'shell_command', 'target_file_only']:
            setattr(self, x, locals()[x])
        self.DE = dependency_analyzer.DependencyAnalyzer(converters)
        # parse the file
        self.root = CL.parse(filename, compiler_options, includes, system_includes, libclang_location, parse_all_comments)
Example #4
0
    def __init__(self,
                 filename,
                 namespaces=(),
                 classes=(),
                 namespace_to_factor=(),
                 appname='',
                 modulename='',
                 moduledoc='',
                 use_properties=False,
                 members_read_only=True,
                 converters=(),
                 compiler_options=None,
                 includes=None,
                 system_includes=None,
                 libclang_location=None,
                 shell_command='',
                 parse_all_comments=True,
                 target_file_only=False):
        """
           Parse the file at construction
           
           Parameters
           -----------

           filename : string
                      Name of the file to parse
           
           namespaces : list of string 
                      Restrict the generation to the given namespaces.
           
           classes : list of string
                      Restrict the generation to the given classes.
           
           appname  : string
                      Name of the application
           
           modulename : string
                      Name of the module
           
           moduledoc : string
                      Documentation of the module

           shell_command : string
                      script command that was called (to regenerate the desc file)

           use_properties : Boolean
                      Transform method with no args into property

           members_read_only : Boolean
                      The members are wrapped "read only"

           includes : string, optional
                      Additional includes to add (-I xxx) for clang

           system_includes : string, optional
                      Additional System includes to add (-isystem xxx) for clang
           
           compiler_options : string, optional 
                      Additional option for clang compiler
           
           libclang_location : string, optional
                      Absolute path to libclang. By default, the detected one.

           parse_all_comments : bool
                      Grab all comments, including non doxygen like [default = True]

           target_file_only : bool
                      Neglect any included files during desc generation [default = False]
        """
        for x in [
                'filename', 'namespaces', 'classes', 'namespace_to_factor',
                'appname', 'modulename', 'moduledoc', 'use_properties',
                'members_read_only', 'shell_command', 'target_file_only'
        ]:
            setattr(self, x, locals()[x])
        self.DE = dependency_analyzer.DependencyAnalyzer(converters)
        # parse the file
        self.root = CL.parse(filename, compiler_options, includes,
                             system_includes, libclang_location,
                             parse_all_comments)