summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/__init__.py
blob: e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 (plain) (blame)

adding-left: 5px; padding-right: 5px; } td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888 } /* Comment */ .highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */ .highlight .k { color: #080; font-weight: bold } /* Keyword */ .highlight .ch { color: #888 } /* Comment.Hashbang */ .highlight .cm { color: #888 } /* Comment.Multiline */ .highlight .cp { color: #C00; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888 } /* Comment.Single */ .highlight .cs { color: #C00; font-weight: bold; background-color: #FFF0F0 } /* Comment.Special */ .highlight .gd { color: #000; background-color: #FDD } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #A00 } /* Generic.Error */ .highlight .gh { color: #333 } /* Generic.Heading */ .highlight .gi { color: #000; background-color: #DFD } /* Generic.Inserted */ .highlight .go { color: #888 } /* Generic.Output */ .highlight .gp { color: #555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666 } /* Generic.Subheading */ .highlight .gt { color: #A00 } /* Generic.Traceback */ .highlight .kc { color: #080; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #080; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #080; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #080 } /* Keyword.Pseudo */ .highlight .kr { color: #080; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #00D; font-weight: bold } /* Literal.Number */ .highlight .s { color: #D20; background-color: #FFF0F0 } /* Literal.String */ .highlight .na { color: #369 } /* Name.Attribute */ .highlight .nb { color: #038 } /* Name.Builtin */ .highlight .nc { color: #B06; font-weight: bold } /* Name.Class */ .highlight .no { color: #036; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555 } /* Name.Decorator */ .highlight .ne { color: #B06; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #06B; font-weight: bold } /* Name.Function */ .highlight .nl { color: #369; font-style: italic } /* Name.Label */ .highlight .nn { color: #B06; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #369; font-weight: bold } /* Name.Property */ .highlight .nt { color: #B06; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #369 } /* Name.Variable */ .highlight .ow { color: #080 } /* Operator.Word */ .highlight .w { color: #BBB } /* Text.Whitespace */ .highlight .mb { color: #00D; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #00D; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #00D; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #00D; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #00D; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #D20; background-color: #FFF0F0 } /* Literal.String.Affix */ .highlight .sb { color: #D20; background-color: #FFF0F0 } /* Literal.String.Backtick */ .highlight .sc { color: #D20; background-color: #FFF0F0 } /* Literal.String.Char */ .highlight .dl { color: #D20; background-color: #FFF0F0 } /* Literal.String.Delimiter */ .highlight .sd { color: #D20; background-color: #FFF0F0 } /* Literal.String.Doc */ .highlight .s2 { color: #D20; background-color: #FFF0F0 } /* Literal.String.Double */ .highlight .se { color: #04D; background-color: #FFF0F0 } /* Literal.String.Escape */ .highlight .sh { color: #D20; background-color: #FFF0F0 } /* Literal.String.Heredoc */ .highlight .si { color: #33B; background-color: #FFF0F0 } /* Literal.String.Interpol */ .highlight .sx { color: #2B2; background-color: #F0FFF0 } /* Literal.String.Other */ .highlight .sr { color: #080; background-color: #FFF0FF } /* Literal.String.Regex */ .highlight .s1 { color: #D20; background-color: #FFF0F0 } /* Literal.String.Single */ .highlight .ss { color: #A60; background-color: #FFF0F0 } /* Literal.String.Symbol */ .highlight .bp { color: #038 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #06B; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #369 } /* Name.Variable.Class */ .highlight .vg { color: #D70 } /* Name.Variable.Global */ .highlight .vi { color: #33B } /* Name.Variable.Instance */ .highlight .vm { color: #369 } /* Name.Variable.Magic */ .highlight .il { color: #00D; font-weight: bold } /* Literal.Number.Integer.Long */
"""Amalgate json-cpp library sources into a single source and header file.

Requires Python 2.6

Example of invocation (must be invoked from json-cpp top directory):
python amalgate.py
"""
import os
import os.path
import sys

class AmalgamationFile:
    def __init__( self, top_dir ):
        self.top_dir = top_dir
        self.blocks = []

    def add_text( self, text ):
        if not text.endswith( "\n" ):
            text += "\n"
        self.blocks.append( text )

    def add_file( self, relative_input_path, wrap_in_comment=False ):
        def add_marker( prefix ):
            self.add_text( "" )
            self.add_text( "// " + "/"*70 )
            self.add_text( "// %s of content of file: %s" % (prefix, relative_input_path.replace("\\","/")) )
            self.add_text( "// " + "/"*70 )
            self.add_text( "" )
        add_marker( "Beginning" )
        f = open( os.path.join( self.top_dir, relative_input_path ), "rt" )
        content = f.read()
        if wrap_in_comment:
            content = "/*\n" + content + "\n*/"
        self.add_text( content )
        f.close()
        add_marker( "End" )
        self.add_text( "\n\n\n\n" )

    def get_value( self ):
        return "".join( self.blocks ).replace("\r\n","\n")

    def write_to( self, output_path ):
        output_dir = os.path.dirname( output_path )
        if output_dir and not os.path.isdir( output_dir ):
            os.makedirs( output_dir )
        f = open( output_path, "wb" )
        f.write( str.encode(self.get_value(), 'UTF-8') )
        f.close()

def amalgamate_source( source_top_dir=None,
                       target_source_path=None,
                       header_include_path=None ):
    """Produces amalgated source.
       Parameters:
           source_top_dir: top-directory
           target_source_path: output .cpp path
           header_include_path: generated header path relative to target_source_path.
    """
    print("Amalgating header...")
    header = AmalgamationFile( source_top_dir )
    header.add_text( "/// Json-cpp amalgated header (http://jsoncpp.sourceforge.net/)." )
    header.add_text( "/// It is intented to be used with #include <%s>" % header_include_path )
    header.add_file( "LICENSE", wrap_in_comment=True )
    header.add_text( "#ifndef JSON_AMALGATED_H_INCLUDED" )
    header.add_text( "# define JSON_AMALGATED_H_INCLUDED" )
    header.add_text( "/// If defined, indicates that the source file is amalgated" )
    header.add_text( "/// to prevent private header inclusion." )
    header.add_text( "#define JSON_IS_AMALGAMATION" )
    header.add_file( "include/json/version.h" )
    header.add_file( "include/json/config.h" )
    header.add_file( "include/json/forwards.h" )
    header.add_file( "include/json/features.h" )
    header.add_file( "include/json/value.h" )
    header.add_file( "include/json/reader.h" )
    header.add_file( "include/json/writer.h" )
    header.add_file( "include/json/assertions.h" )
    header.add_text( "#endif //ifndef JSON_AMALGATED_H_INCLUDED" )

    target_header_path = os.path.join( os.path.dirname(target_source_path), header_include_path )
    print("Writing amalgated header to %r" % target_header_path)
    header.write_to( target_header_path )

    base, ext = os.path.splitext( header_include_path )
    forward_header_include_path = base + "-forwards" + ext
    print("Amalgating forward header...")
    header = AmalgamationFile( source_top_dir )
    header.add_text( "/// Json-cpp amalgated forward header (http://jsoncpp.sourceforge.net/)." )
    header.add_text( "/// It is intented to be used with #include <%s>" % forward_header_include_path )
    header.add_text( "/// This header provides forward declaration for all JsonCpp types." )
    header.add_file( "LICENSE", wrap_in_comment=True )
    header.add_text( "#ifndef JSON_FORWARD_AMALGATED_H_INCLUDED" )
    header.add_text( "# define JSON_FORWARD_AMALGATED_H_INCLUDED" )
    header.add_text( "/// If defined, indicates that the source file is amalgated" )
    header.add_text( "/// to prevent private header inclusion." )
    header.add_text( "#define JSON_IS_AMALGAMATION" )
    header.add_file( "include/json/config.h" )
    header.add_file( "include/json/forwards.h" )
    header.add_text( "#endif //ifndef JSON_FORWARD_AMALGATED_H_INCLUDED" )

    target_forward_header_path = os.path.join( os.path.dirname(target_source_path),
                                               forward_header_include_path )
    print("Writing amalgated forward header to %r" % target_forward_header_path)
    header.write_to( target_forward_header_path )

    print("Amalgating source...")
    source = AmalgamationFile( source_top_dir )
    source.add_text( "/// Json-cpp amalgated source (http://jsoncpp.sourceforge.net/)." )
    source.add_text( "/// It is intented to be used with #include <%s>" % header_include_path )
    source.add_file( "LICENSE", wrap_in_comment=True )
    source.add_text( "" )
    source.add_text( "#include <%s>" % header_include_path )
    source.add_text( "" )
    lib_json = "src/lib_json"
    source.add_file( os.path.join(lib_json, "json_tool.h") )
    source.add_file( os.path.join(lib_json, "json_reader.cpp") )
    source.add_file( os.path.join(lib_json, "json_batchallocator.h") )
    source.add_file( os.path.join(lib_json, "json_valueiterator.inl") )
    source.add_file( os.path.join(lib_json, "json_value.cpp") )
    source.add_file( os.path.join(lib_json, "json_writer.cpp") )

    print("Writing amalgated source to %r" % target_source_path)
    source.write_to( target_source_path )

def main():
    usage = """%prog [options]
Generate a single amalgated source and header file from the sources.
"""
    from optparse import OptionParser
    parser = OptionParser(usage=usage)
    parser.allow_interspersed_args = False
    parser.add_option("-s", "--source", dest="target_source_path", action="store", default="dist/jsoncpp.cpp",
        help="""Output .cpp source path. [Default: %default]""")
    parser.add_option("-i", "--include", dest="header_include_path", action="store", default="json/json.h",
        help="""Header include path. Used to include the header from the amalgated source file. [Default: %default]""")
    parser.add_option("-t", "--top-dir", dest="top_dir", action="store", default=os.getcwd(),
        help="""Source top-directory. [Default: %default]""")
    parser.enable_interspersed_args()
    options, args = parser.parse_args()

    msg = amalgamate_source( source_top_dir=options.top_dir,
                             target_source_path=options.target_source_path,
                             header_include_path=options.header_include_path )
    if msg:
        sys.stderr.write( msg + "\n" )
        sys.exit( 1 )
    else:
        print("Source succesfully amalagated")

if __name__ == "__main__":
    main()