diff options
author | bradnelson@google.com <bradnelson@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-22 20:06:39 +0000 |
---|---|---|
committer | bradnelson@google.com <bradnelson@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-22 20:06:39 +0000 |
commit | bcc8a4de1efd054adf9cb67ff55c1d833a82eb2c (patch) | |
tree | 77bea4acdf0eccfa4e9cc882363cb25c3cae2d3a /native_client_sdk | |
parent | 2da5fba06305597384da15355e29aa09bc66385d (diff) | |
download | chromium_src-bcc8a4de1efd054adf9cb67ff55c1d833a82eb2c.zip chromium_src-bcc8a4de1efd054adf9cb67ff55c1d833a82eb2c.tar.gz chromium_src-bcc8a4de1efd054adf9cb67ff55c1d833a82eb2c.tar.bz2 |
Dropping nacl sdk dead code (documentation, project_template).
The documentation and project template are no longer used in the shipping sdk.
Dropping them.
Will drop pymox DEPS entry in a separate CL as this includes the last used reference.
BUG=None
TEST=None
R=binji@chromium.org
Review URL: https://chromiumcodereview.appspot.com/16972010
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@208078 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'native_client_sdk')
23 files changed, 0 insertions, 3989 deletions
diff --git a/native_client_sdk/src/documentation/Doxyfile b/native_client_sdk/src/documentation/Doxyfile deleted file mode 100644 index 54b8213..0000000 --- a/native_client_sdk/src/documentation/Doxyfile +++ /dev/null @@ -1,1663 +0,0 @@ -# Doxyfile 1.7.2 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = "c_salt" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = scons-out/documentation - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = YES - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = YES - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command <command> <input-file>, where <command> is the value of -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = YES - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = ./c_salt \ - ./examples \ - ./documentation - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.vhd *.vhdl - -FILE_PATTERNS = *.h \ - *.dox - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = _*.h - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = ./documentation/images-dox - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = documentation/header.dox - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = documentation/footer.dox - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = documentation/stylesheet-dox.css - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 30 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> -# Qt Help Project / Custom Filters</a>. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> -# Qt Help Project / Filter Attributes</a>. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [0,1..20]) -# that doxygen will group on one line in the generated HTML documentation. -# Note that a value of 0 will completely suppress the enum values from appearing in the overview section. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 251 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. - -USE_MATHJAX = NO - -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = NO - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = YES - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = __native_client__ \ - DOXYGEN_SHOULD_SKIP_THIS \ - __attribute__(x)= \ - EXTERN_C_BEGIN= \ - EXTERN_C_END= - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to -# install and use dot, since it yields more powerful graphs. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. - -DOT_NUM_THREADS = 0 - -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = FreeSans.ttf - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = YES - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = YES - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = YES - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will generate a graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif. -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the -# \mscfile command). - -MSCFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 10 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = YES - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES diff --git a/native_client_sdk/src/documentation/build.scons b/native_client_sdk/src/documentation/build.scons deleted file mode 100644 index b4751f8..0000000 --- a/native_client_sdk/src/documentation/build.scons +++ /dev/null @@ -1,28 +0,0 @@ -#! -*- python -*- -# -# Copyright (c) 2010 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -"""scons script for building the Doxygen-based documentation for c_salt""" - -Import('env') - -env.SetDefault(DOXYGEN=ARGUMENTS.get('DOXYGEN', 'doxygen')) - -# Gate on host platform rather than target, since all are supported. -if env['PLATFORM'] in ['win32', 'cygwin']: - env['ENV']['NACL_SDK_PLATFORM'] = 'windows' -elif env['PLATFORM'] in ['darwin']: - env['ENV']['NACL_SDK_PLATFORM'] = 'mac' -else: - env['ENV']['NACL_SDK_PLATFORM'] = 'linux' - -# The output is generated into scons-out/doc (c.f. Doxyfile). -# Point your browser at scons-out/doc/html/index.html -node = env.Command( - target='doxygen.log', - source='Doxyfile', - action='${DOXYGEN} documentation/Doxyfile 2>&1 > ${TARGET}') -AlwaysBuild(node) -env.AddNodeAliases(node, [], 'docs') diff --git a/native_client_sdk/src/documentation/check.sh b/native_client_sdk/src/documentation/check.sh deleted file mode 100755 index ce3b49f..0000000 --- a/native_client_sdk/src/documentation/check.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -# simple script to check html via tidy. Either specify html files on -# command line or rely on default which checks all html files in -# current directory -set -o nounset -set -o errexit - - -CheckFile () { - echo "========================================" - echo "checking $1" - echo "========================================" - tidy -e -q $1 -} - - -if [ $# -eq 0 ] ; then - for file in *.html ; do - CheckFile ${file} - done -else - for file in $* ; do - CheckFile ${file} - done -fi diff --git a/native_client_sdk/src/documentation/footer.dox b/native_client_sdk/src/documentation/footer.dox deleted file mode 100644 index 8a944c1..0000000 --- a/native_client_sdk/src/documentation/footer.dox +++ /dev/null @@ -1,22 +0,0 @@ - <p id="license"> - Except as otherwise - <a href="http://code.google.com/policies.html#restrictions">noted</a>, - the content of this page is licensed under a - <a href="http://www.google.com/url?sa=D&q=http%3A%2F%2Fcreativecommons.org/licenses/by/2.5/">Creative Commons - Attribution 2.5 license</a>. - </p> - - <p align="center"><b>Warning: This API is - currently in development and is subject to change.</b></p> - - <address> - ©2010 Google - </address> - - <address> - Generated $date by - <a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion - </address> - - </body> -</html> diff --git a/native_client_sdk/src/documentation/header.dox b/native_client_sdk/src/documentation/header.dox deleted file mode 100644 index a261dd3..0000000 --- a/native_client_sdk/src/documentation/header.dox +++ /dev/null @@ -1,14 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> - <title>$title</title> - <link href="./tabs.css" rel="stylesheet" type="text/css"> - <link href="./stylesheet-dox.css" rel="stylesheet" type="text/css"> - <link href="./stylesheet-dox-all.css" rel="stylesheet" type="text/css"> - </head> - <body> - <div id="toplinks"> - <a href="http://code.google.com/p/nativeclient-sdk/"> - Native Client SDK homepage</a> - </div> diff --git a/native_client_sdk/src/documentation/images-dox/README.txt b/native_client_sdk/src/documentation/images-dox/README.txt deleted file mode 100644 index 9a9e18c..0000000 --- a/native_client_sdk/src/documentation/images-dox/README.txt +++ /dev/null @@ -1,9 +0,0 @@ -This directory holds all images that go into the doxygen-generated -API reference doc. To include an image, use code like the following: - -@image html figure.jpg - -If you want a caption, specify it like this: - -@image html figure.jpg "Test image" - diff --git a/native_client_sdk/src/documentation/index.dox b/native_client_sdk/src/documentation/index.dox deleted file mode 100644 index 2af602e..0000000 --- a/native_client_sdk/src/documentation/index.dox +++ /dev/null @@ -1,46 +0,0 @@ -/** @mainpage c_salt Reference Documentation - - This reference documentation describes the c_salt API, which is - an open-source API for browser plugins that layers on - top of the Pepper API and the NPAPI. - You can use the c_salt API - in <a href="http://code.google.com/p/nativeclient-sdk">Native Client</a> - modules to communicate with the Google Chrome browser. - This page has the following contents: - - - @ref reading - - @ref modules - - @ref about - - - @section reading Before you start - - This documentation assumes that you have read and understood - the following pages in the Native Client SDK project: - - - <a href="http://code.google.com/p/nativeclient-sdk/">Getting started</a> - - - @section modules API categories - -The c_salt API consists of a C++ API in the c_salt namespace. - -(Details TBD)... - - - @section about About this doc - - <p> - The tabs at the top of each page take you to the following sections. - </p> - - - <b>Main Page</b>: This page - - <a href="modules.html"><b>Modules</b></a>: Lets you find API by functional area - - <a href="annotated.html"><b>Data Structures</b></a>: - List of classes and data structures in c_salt. - - <a href="files.html"><b>Files</b></a>: - The header files used to generate this documentation, - with file descriptions and links to generated doc. - Don't miss the <a href="globals.html">File member index</a>. - - */
\ No newline at end of file diff --git a/native_client_sdk/src/documentation/modules.dox b/native_client_sdk/src/documentation/modules.dox deleted file mode 100644 index 3923ccb..0000000 --- a/native_client_sdk/src/documentation/modules.dox +++ /dev/null @@ -1,22 +0,0 @@ -// This is a doxygen file that describes the documentation groups - -/** - -@defgroup c_salt C Salt C++ API -Description of c_salt C++ API goes here. - -@defgroup examples c_salt examples -Here are the examples that use c_salt - -@defgroup npapi NPAPI bindings for c_salt -@ingroup c_salt -Defines the NPAPI bindings for c_salt - -@defgroup ppapi PPAPI bindings for c_salt -@ingroup c_salt -Defines the PPAPI (i.e. Pepper2) bindings for c_salt - -@defgroup tests c_salt integration and unit tests -Integration and unit tests for c_salt. - -*/ diff --git a/native_client_sdk/src/documentation/stylesheet-dox.css b/native_client_sdk/src/documentation/stylesheet-dox.css deleted file mode 100644 index 81d1a42..0000000 --- a/native_client_sdk/src/documentation/stylesheet-dox.css +++ /dev/null @@ -1,478 +0,0 @@ -body, table, div, p, dl { - font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; - font-size: 12px; -} - -/* @group Heading Levels */ - -h1 { - text-align: center; - font-size: 150%; -} - -h1 a, h2 a, h3 a, h4 a { - font-weight:bold; -} - -h2 { - font-size: 120%; - margin-top: 2.0em; - margin-bottom: 0.5em; -} - -h3 { - font-size: 100%; -} - -div.contents { - margin-top: 2.0em; -} - -/* @end */ - -caption { - font-weight: bold; - font-size: 9px; -} - -div.qindex, div.navpath, div.navtab{ - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; -} - -div.qindex, div.navpath { - width: 100%; - line-height: 140%; -} - -div.navtab { - margin-right: 15px; -} - -/* @group Link Styling */ - -a { - color: #153788; - font-weight: normal; - text-decoration: none; -} - -.contents a:visited { - color: #1b77c5; -} - -a:hover { - text-decoration: underline; -} - -a.qindex { - font-weight: bold; -} - -a.qindexHL { - font-weight: bold; - background-color: #6666cc; - color: #ffffff; - border: 1px double #9295C2; -} - -a.el { - font-weight: bold; -} - -a.elRef { -} - -a.code { -} - -a.codeRef { -} - -/* @end */ - -dl.el { - margin-left: -1cm; -} - -.fragment { - font-family: monospace, fixed; - font-size: 105%; -} - -pre.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - padding: 4px 6px; - margin: 4px 8px 4px 2px; -} - -div.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background: white; - color: black; - margin-right: 20px; - margin-left: 20px; -} - -td.indexkey { - background-color: #e8eef2; - font-weight: bold; - border: 1px solid #CCCCCC; - margin: 2px 0px 2px 0; - padding: 2px 10px; -} - -td.indexvalue { - background-color: #e8eef2; - border: 1px solid #CCCCCC; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #f0f0f0; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { -} - -img.formulaInl { - vertical-align: middle; -} - -/* @group Code Colorization */ - -span.keyword { - color: #008000 -} - -span.keywordtype { - color: #604020 -} - -span.keywordflow { - color: #e08000 -} - -span.comment { - color: #800000 -} - -span.preprocessor { - color: #806020 -} - -span.stringliteral { - color: #002080 -} - -span.charliteral { - color: #008080 -} - -span.vhdldigit { - color: #ff00ff -} - -span.vhdlchar { - color: #000000 -} - -span.vhdlkeyword { - color: #700070 -} - -span.vhdllogic { - color: #ff0000 -} - -/* @end */ - -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} - -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #84b0c7; -} - -th.dirtab { - background: #e8eef2; - font-weight: bold; -} - -hr { - height: 0; - border: none; - border-top: 1px solid #666; -} - -/* @group Member Descriptions */ - -.mdescLeft, .mdescRight, -.memItemLeft, .memItemRight, -.memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #FAFAFA; - border: none; - margin: 4px; - padding: 1px 0 0 8px; -} - -.mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - color: #555; -} - -.memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid #ccc; -} - -.memTemplParams { - color: #606060; -} - -/* @end */ - -/* @group Member Details */ - -/* Styles for detailed member documentation */ - -.memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; - margin-left: 3px; -} - -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.memitem { - padding: 0; -} - -.memname { - white-space: nowrap; - font-weight: bold; -} - -.memproto, .memdoc { - border: 1px solid #84b0c7; -} - -.memproto { - padding: 0; - background-color: #d5e1e8; - font-weight: bold; - -webkit-border-top-left-radius: 8px; - -webkit-border-top-right-radius: 8px; - -moz-border-radius-topleft: 8px; - -moz-border-radius-topright: 8px; -} - -.memdoc { - padding: 2px 5px; - background-color: #eef3f5; - border-top-width: 0; - -webkit-border-bottom-left-radius: 8px; - -webkit-border-bottom-right-radius: 8px; - -moz-border-radius-bottomleft: 8px; - -moz-border-radius-bottomright: 8px; -} - -.memdoc p, .memdoc dl, .memdoc ul { - margin: 6px 0; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; -} -.paramname em { - font-style: normal; -} - -/* @end */ - -/* @group Directory (tree) */ - -/* for the tree view */ - -.ftvtree { - font-family: sans-serif; - margin: 0.5em; -} - -/* these are for tree view when used as main index */ - -.directory { - font-size: 9pt; - font-weight: bold; -} - -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -/* -The following two styles can be used to replace the root node title -with an image of your choice. Simply uncomment the next two styles, -specify the name of your image and be sure to set 'height' to the -proper pixel height of your image. -*/ - -/* -.directory h3.swap { - height: 61px; - background-repeat: no-repeat; - background-image: url("yourimage.gif"); -} -.directory h3.swap span { - display: none; -} -*/ - -.directory > h3 { - margin-top: 0; -} - -.directory p { - margin: 0px; - white-space: nowrap; -} - -.directory div { - display: none; - margin: 0px; -} - -.directory img { - vertical-align: -30%; -} - -/* these are for tree view when not used as main index */ - -.directory-alt { - font-size: 100%; - font-weight: bold; -} - -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -.directory-alt > h3 { - margin-top: 0; -} - -.directory-alt p { - margin: 0px; - white-space: nowrap; -} - -.directory-alt div { - display: none; - margin: 0px; -} - -.directory-alt img { - vertical-align: -30%; -} - -/* @end */ - -address { - font-style: normal; - text-align: center; - font-size: 90%; - color: gray; -} - -DIV.tabs A, #toplinks -{ - font-size : 9px; -} - -#toplinks { - text-align: right; - margin-bottom: -1.9em; -} - -.pending { - /* display:none; */ - color:red; font-weight:bold; -} - -#license { - color:gray; - font-size:90%; - border-top:1px solid; - border-color:gray; - padding-top:1em; - margin-top:3em; - text-align:center; -} diff --git a/native_client_sdk/src/documentation/stylesheet.css b/native_client_sdk/src/documentation/stylesheet.css deleted file mode 100644 index 3d17af0..0000000 --- a/native_client_sdk/src/documentation/stylesheet.css +++ /dev/null @@ -1,101 +0,0 @@ -@charset "utf-8"; -a:link { color: #0000cc; } -body { - background: #fff; margin: 3px 8px; - font-family: arial, sans-serif; -} - -body { font-size: 83%;} -pre, code, p kbd { font-size: 120%;} - -h1 { font-size: x-large; } -h2 { font-size: large; } -h3 { font-size: medium; } -h4 { font-size: small; } - -img { border: 1px solid #ccc; } - -pre { - margin-left: 2em; - padding: 0.5em; - border-left: 3px solid #ccc; -} - -pre.no-bar { - padding: 0; - border-left: 0; -} - -table { - border: 1px solid #999999; - border-collapse: collapse; -} - -th { - border: 1px solid #999999; - padding: 0.25em 0.5em; - background: #ccc; -} - -td { - border-bottom: 1px dotted #999999; - border-left: 1px dotted #999999; - text-align: left; - padding: 0.25em 0.5em; -} - -td pre.listing { - margin: 0.25em 0.25em 0.25em 0; -} - -pre.listing { - padding: 0; - background-color: #fff; - border: none; -} - -div#toplink { - font-size: small; - text-align: right; - margin-bottom: -2em; -} - -.caption { - font-weight:bold -} - -#license { - color:gray; - font-size:small; - border-top:1px solid; - border-color:gray; - padding:1em; - margin-top:3em; - text-align:center; -} - -.technote { - border:1px solid #999; - background:#ccc; - margin:0em 5em; - padding: 0.25em 0.5em; -} - -.notapplicable { - color:lightgray; - font-style:italic; -} - -pre kbd { - background:rgb(221, 248, 204); -} - -table caption { - font-style:italic; - text-align:left; -} - -.comment { - display:none; /* comment this line out if you want to see comments */ - color:red; font-weight:bold; -} diff --git a/native_client_sdk/src/project_templates/README b/native_client_sdk/src/project_templates/README deleted file mode 100644 index 5aca398..0000000 --- a/native_client_sdk/src/project_templates/README +++ /dev/null @@ -1,45 +0,0 @@ -Welcome to the Native Client SDK project_templates directory. - -Currently, this directory contains a mechanism to allow a developer to -bootstrap a native client project and write a lot of the NaCl-specific code -automatically, so the developer can add her own functionality quickly. The -projects created are designed to be self-contained, meaning that they have -everything they need to run, except a server. - -To start a project, run "./init_project.py" or "python init_project.py" -depending on your system configuration. The script will give you usage -information when run with -h or when insufficient or malformed arguments are -provided. - -The result of the script is a project with the name you provide at a location -of your choice. If you have your own server, you may create the project in -a location it serves. Otherwise, you may create a project under the SDK -examples directory and examples/httpd.py to serve your project quickly - at -least temporarily. - -In the future, this directory is intended as a repository for useful stub code, -code snippets, and code generators that can be used to facilitate rapid -development. For now we support initial project setup via init_project.py, but -any generically useful code can be added here if it follows a reasonable -organization. The organization is as follows: - -project_templates: - Contains any top-level scripting elements that apply or may come in useful - for the generation of all NaCl/Pepper2 projects, common Makefile sections, - and this README. -project_templates/[language]: - For any given language there should be a directory with a name that is - commonly associated with that language. -project_templates/[topic] -project_templates/[language]/[topic] - For any given programming topic, such as audio, 2d, or 3d programming, there - should be a directory at the root level for any components that are not - language specific and that may apply to that topic. For corresponding - components that are language specific, a sub-directory for the topic may - also be created under the language directory. - -Note that the layout in this directory does not reflect the layout of the -projects that are created. It is merely a set of simple guidelines to help -organize generic code and utilities so they can be managed here. How -generated projects are laid out is left up to the design of the particular -code-generator. diff --git a/native_client_sdk/src/project_templates/c/build.scons b/native_client_sdk/src/project_templates/c/build.scons deleted file mode 100644 index 6836f4e..0000000 --- a/native_client_sdk/src/project_templates/c/build.scons +++ /dev/null @@ -1,15 +0,0 @@ -#! -*- python -*- -# -# Copyright (c) 2011 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -import make_nacl_env -import os - -nacl_env = make_nacl_env.NaClEnvironment( - nacl_platform=os.getenv('NACL_TARGET_PLATFORM')) - -sources = ['<PROJECT_NAME>.c'] - -nacl_env.AllNaClModules(sources, '<PROJECT_NAME>') diff --git a/native_client_sdk/src/project_templates/c/project_file.c b/native_client_sdk/src/project_templates/c/project_file.c deleted file mode 100644 index 7f25bd6..0000000 --- a/native_client_sdk/src/project_templates/c/project_file.c +++ /dev/null @@ -1,227 +0,0 @@ -/** @file <PROJECT_NAME>.c - * This example demonstrates loading, running and scripting a very simple - * NaCl module. - */ -#include <stdlib.h> -#include <string.h> -#include "ppapi/c/pp_errors.h" -#include "ppapi/c/pp_module.h" -#include "ppapi/c/pp_var.h" -#include "ppapi/c/ppb.h" -#include "ppapi/c/ppb_instance.h" -#include "ppapi/c/ppb_messaging.h" -#include "ppapi/c/ppb_var.h" -#include "ppapi/c/ppp.h" -#include "ppapi/c/ppp_instance.h" -#include "ppapi/c/ppp_messaging.h" - -static PP_Module module_id = 0; -static struct PPB_Messaging* messaging_interface = NULL; -static struct PPB_Var* var_interface = NULL; - -/** - * Returns a mutable C string contained in the @a var or NULL if @a var is not - * string. This makes a copy of the string in the @a var and adds a NULL - * terminator. Note that VarToUtf8() does not guarantee the NULL terminator on - * the returned string. See the comments for VarToUtf8() in ppapi/c/ppb_var.h - * for more info. The caller is responsible for freeing the returned memory. - * @param[in] var PP_Var containing string. - * @return a mutable C string representation of @a var. - * @note The caller is responsible for freeing the returned string. - */ -/* TODO(sdk_user): 2. Uncomment this when you need it. It is commented out so - * that the compiler doesn't complain about unused functions. - */ -#if 0 -static char* AllocateCStrFromVar(struct PP_Var var) { - uint32_t len = 0; - if (var_interface != NULL) { - const char* var_c_str = var_interface->VarToUtf8(var, &len); - if (len > 0) { - char* c_str = (char*)malloc(len + 1); - memcpy(c_str, var_c_str, len); - c_str[len] = '\0'; - return c_str; - } - } - return NULL; -} -#endif - -/** - * Creates a new string PP_Var from C string. The resulting object will be a - * refcounted string object. It will be AddRef()ed for the caller. When the - * caller is done with it, it should be Release()d. - * @param[in] str C string to be converted to PP_Var - * @return PP_Var containing string. - */ -/* TODO(sdk_user): 3. Uncomment this when you need it. It is commented out so - * that the compiler doesn't complain about unused functions. - */ -#if 0 -static struct PP_Var AllocateVarFromCStr(const char* str) { - if (var_interface != NULL) - return var_interface->VarFromUtf8(module_id, str, strlen(str)); - return PP_MakeUndefined(); -} -#endif - -/** - * Called when the NaCl module is instantiated on the web page. The identifier - * of the new instance will be passed in as the first argument (this value is - * generated by the browser and is an opaque handle). This is called for each - * instantiation of the NaCl module, which is each time the <embed> tag for - * this module is encountered. - * - * If this function reports a failure (by returning @a PP_FALSE), the NaCl - * module will be deleted and DidDestroy will be called. - * @param[in] instance The identifier of the new instance representing this - * NaCl module. - * @param[in] argc The number of arguments contained in @a argn and @a argv. - * @param[in] argn An array of argument names. These argument names are - * supplied in the <embed> tag, for example: - * <embed id="nacl_module" dimensions="2"> - * will produce two arguments, one named "id" and one named "dimensions". - * @param[in] argv An array of argument values. These are the values of the - * arguments listed in the <embed> tag. In the above example, there will - * be two elements in this array, "nacl_module" and "2". The indices of - * these values match the indices of the corresponding names in @a argn. - * @return @a PP_TRUE on success. - */ -static PP_Bool Instance_DidCreate(PP_Instance instance, - uint32_t argc, - const char* argn[], - const char* argv[]) { - return PP_TRUE; -} - -/** - * Called when the NaCl module is destroyed. This will always be called, - * even if DidCreate returned failure. This routine should deallocate any data - * associated with the instance. - * @param[in] instance The identifier of the instance representing this NaCl - * module. - */ -static void Instance_DidDestroy(PP_Instance instance) { -} - -/** - * Called when the position, the size, or the clip rect of the element in the - * browser that corresponds to this NaCl module has changed. - * @param[in] instance The identifier of the instance representing this NaCl - * module. - * @param[in] position The location on the page of this NaCl module. This is - * relative to the top left corner of the viewport, which changes as the - * page is scrolled. - * @param[in] clip The visible region of the NaCl module. This is relative to - * the top left of the plugin's coordinate system (not the page). If the - * plugin is invisible, @a clip will be (0, 0, 0, 0). - */ -static void Instance_DidChangeView(PP_Instance instance, - const struct PP_Rect* position, - const struct PP_Rect* clip) { -} - -/** - * Notification that the given NaCl module has gained or lost focus. - * Having focus means that keyboard events will be sent to the NaCl module - * represented by @a instance. A NaCl module's default condition is that it - * will not have focus. - * - * Note: clicks on NaCl modules will give focus only if you handle the - * click event. You signal if you handled it by returning @a true from - * HandleInputEvent. Otherwise the browser will bubble the event and give - * focus to the element on the page that actually did end up consuming it. - * If you're not getting focus, check to make sure you're returning true from - * the mouse click in HandleInputEvent. - * @param[in] instance The identifier of the instance representing this NaCl - * module. - * @param[in] has_focus Indicates whether this NaCl module gained or lost - * event focus. - */ -static void Instance_DidChangeFocus(PP_Instance instance, - PP_Bool has_focus) { -} - -/** - * Handler that gets called after a full-frame module is instantiated based on - * registered MIME types. This function is not called on NaCl modules. This - * function is essentially a place-holder for the required function pointer in - * the PPP_Instance structure. - * @param[in] instance The identifier of the instance representing this NaCl - * module. - * @param[in] url_loader A PP_Resource an open PPB_URLLoader instance. - * @return PP_FALSE. - */ -static PP_Bool Instance_HandleDocumentLoad(PP_Instance instance, - PP_Resource url_loader) { - /* NaCl modules do not need to handle the document load function. */ - return PP_FALSE; -} - - -/** - * Handler for messages coming in from the browser via postMessage. The - * @a var_message can contain anything: a JSON string; a string that encodes - * method names and arguments; etc. For example, you could use JSON.stringify - * in the browser to create a message that contains a method name and some - * parameters, something like this: - * var json_message = JSON.stringify({ "myMethod" : "3.14159" }); - * nacl_module.postMessage(json_message); - * On receipt of this message in @a var_message, you could parse the JSON to - * retrieve the method name, match it to a function call, and then call it with - * the parameter. - * @param[in] instance The instance ID. - * @param[in] message The contents, copied by value, of the message sent from - * browser via postMessage. - */ -void Messaging_HandleMessage(PP_Instance instance, struct PP_Var var_message) { - /* TODO(sdk_user): 1. Make this function handle the incoming message. */ -} - -/** - * Entry points for the module. - * Initialize instance interface and scriptable object class. - * @param[in] a_module_id Module ID - * @param[in] get_browser_interface Pointer to PPB_GetInterface - * @return PP_OK on success, any other value on failure. - */ -PP_EXPORT int32_t PPP_InitializeModule(PP_Module a_module_id, - PPB_GetInterface get_browser_interface) { - module_id = a_module_id; - var_interface = (struct PPB_Var*)(get_browser_interface(PPB_VAR_INTERFACE)); - messaging_interface = - (struct PPB_Messaging*)(get_browser_interface(PPB_MESSAGING_INTERFACE)); - return PP_OK; -} - -/** - * Returns an interface pointer for the interface of the given name, or NULL - * if the interface is not supported. - * @param[in] interface_name name of the interface - * @return pointer to the interface - */ -PP_EXPORT const void* PPP_GetInterface(const char* interface_name) { - if (strcmp(interface_name, PPP_INSTANCE_INTERFACE) == 0) { - static struct PPP_Instance instance_interface = { - &Instance_DidCreate, - &Instance_DidDestroy, - &Instance_DidChangeView, - &Instance_DidChangeFocus, - &Instance_HandleDocumentLoad - }; - return &instance_interface; - } else if (strcmp(interface_name, PPP_MESSAGING_INTERFACE) == 0) { - static struct PPP_Messaging messaging_interface = { - &Messaging_HandleMessage - }; - return &messaging_interface; - } - return NULL; -} - -/** - * Called before the plugin module is unloaded. - */ -PP_EXPORT void PPP_ShutdownModule() { -} diff --git a/native_client_sdk/src/project_templates/cc/build.scons b/native_client_sdk/src/project_templates/cc/build.scons deleted file mode 100644 index 04d661b..0000000 --- a/native_client_sdk/src/project_templates/cc/build.scons +++ /dev/null @@ -1,16 +0,0 @@ -#! -*- python -*- -# -# Copyright (c) 2011 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -import make_nacl_env -import nacl_utils -import os - -nacl_env = make_nacl_env.NaClEnvironment( - use_c_plus_plus_libs=True, nacl_platform=os.getenv('NACL_TARGET_PLATFORM')) - -sources = ['<PROJECT_NAME>.cc'] - -nacl_env.AllNaClModules(sources, '<PROJECT_NAME>') diff --git a/native_client_sdk/src/project_templates/cc/project_file.cc b/native_client_sdk/src/project_templates/cc/project_file.cc deleted file mode 100644 index c0123fe..0000000 --- a/native_client_sdk/src/project_templates/cc/project_file.cc +++ /dev/null @@ -1,87 +0,0 @@ -/// @file <PROJECT_NAME>.cc -/// This example demonstrates loading, running and scripting a very simple NaCl -/// module. To load the NaCl module, the browser first looks for the -/// CreateModule() factory method (at the end of this file). It calls -/// CreateModule() once to load the module code from your .nexe. After the -/// .nexe code is loaded, CreateModule() is not called again. -/// -/// Once the .nexe code is loaded, the browser than calls the CreateInstance() -/// method on the object returned by CreateModule(). It calls CreateInstance() -/// each time it encounters an <embed> tag that references your NaCl module. -/// -/// The browser can talk to your NaCl module via the postMessage() Javascript -/// function. When you call postMessage() on your NaCl module from the browser, -/// this becomes a call to the HandleMessage() method of your pp::Instance -/// subclass. You can send messages back to the browser by calling the -/// PostMessage() method on your pp::Instance. Note that these two methods -/// (postMessage() in Javascript and PostMessage() in C++) are asynchronous. -/// This means they return immediately - there is no waiting for the message -/// to be handled. This has implications in your program design, particularly -/// when mutating property values that are exposed to both the browser and the -/// NaCl module. - -#include <cstdio> -#include <string> -#include "ppapi/cpp/instance.h" -#include "ppapi/cpp/module.h" -#include "ppapi/cpp/var.h" - -/// The Instance class. One of these exists for each instance of your NaCl -/// module on the web page. The browser will ask the Module object to create -/// a new Instance for each occurence of the <embed> tag that has these -/// attributes: -/// type="application/x-nacl" -/// src="<PROJECT_NAME>.nmf" -/// To communicate with the browser, you must override HandleMessage() for -/// receiving messages from the borwser, and use PostMessage() to send messages -/// back to the browser. Note that this interface is entirely asynchronous. -class <ProjectName>Instance : public pp::Instance { - public: - /// The constructor creates the plugin-side instance. - /// @param[in] instance the handle to the browser-side plugin instance. - explicit <ProjectName>Instance(PP_Instance instance) : pp::Instance(instance) - {} - virtual ~<ProjectName>Instance() {} - - /// Handler for messages coming in from the browser via postMessage(). The - /// @a var_message can contain anything: a JSON string; a string that encodes - /// method names and arguments; etc. For example, you could use - /// JSON.stringify in the browser to create a message that contains a method - /// name and some parameters, something like this: - /// var json_message = JSON.stringify({ "myMethod" : "3.14159" }); - /// nacl_module.postMessage(json_message); - /// On receipt of this message in @a var_message, you could parse the JSON to - /// retrieve the method name, match it to a function call, and then call it - /// with the parameter. - /// @param[in] var_message The message posted by the browser. - virtual void HandleMessage(const pp::Var& var_message) { - // TODO(sdk_user): 1. Make this function handle the incoming message. - } -}; - -/// The Module class. The browser calls the CreateInstance() method to create -/// an instance of your NaCl module on the web page. The browser creates a new -/// instance for each <embed> tag with type="application/x-nacl". -class <ProjectName>Module : public pp::Module { - public: - <ProjectName>Module() : pp::Module() {} - virtual ~<ProjectName>Module() {} - - /// Create and return a <ProjectName>Instance object. - /// @param[in] instance The browser-side instance. - /// @return the plugin-side instance. - virtual pp::Instance* CreateInstance(PP_Instance instance) { - return new <ProjectName>Instance(instance); - } -}; - -namespace pp { -/// Factory function called by the browser when the module is first loaded. -/// The browser keeps a singleton of this module. It calls the -/// CreateInstance() method on the object you return to make instances. There -/// is one instance per <embed> tag on the page. This is the main binding -/// point for your NaCl module with the browser. -Module* CreateModule() { - return new <ProjectName>Module(); -} -} // namespace pp diff --git a/native_client_sdk/src/project_templates/html/project_file.html b/native_client_sdk/src/project_templates/html/project_file.html deleted file mode 100644 index db3bc1a..0000000 --- a/native_client_sdk/src/project_templates/html/project_file.html +++ /dev/null @@ -1,95 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <title><ProjectName>!</title> - - <script type="text/javascript"> - <ProjectName>Module = null; // Global application object. - statusText = 'NO-STATUS'; - - // Indicate load success. - function moduleDidLoad() { - <ProjectName>Module = document.getElementById('<PROJECT_NAME>'); - updateStatus('SUCCESS'); - } - - // The 'message' event handler. This handler is fired when the NaCl module - // posts a message to the browser by calling PPB_Messaging.PostMessage() - // (in C) or pp::Instance.PostMessage() (in C++). This implementation - // simply displays the content of the message in an alert panel. - function handleMessage(message_event) { - alert(message_event.data); - } - - // If the page loads before the Native Client module loads, then set the - // status message indicating that the module is still loading. Otherwise, - // do not change the status message. - function pageDidLoad() { - if (<ProjectName>Module == null) { - updateStatus('LOADING...'); - } else { - // It's possible that the Native Client module onload event fired - // before the page's onload event. In this case, the status message - // will reflect 'SUCCESS', but won't be displayed. This call will - // display the current message. - updateStatus(); - } - } - - // Set the global status message. If the element with id 'statusField' - // exists, then set its HTML to the status message as well. - // opt_message The message test. If this is null or undefined, then - // attempt to set the element with id 'statusField' to the value of - // |statusText|. - function updateStatus(opt_message) { - if (opt_message) - statusText = opt_message; - var statusField = document.getElementById('status_field'); - if (statusField) { - statusField.innerHTML = statusText; - } - } - </script> -</head> -<body onload="pageDidLoad()"> - -<h1>Native Client Module <ProjectName></h1> -<p> - <!-- Load the published .nexe. This includes the 'nacl' attribute which - shows how to load multi-architecture modules. Each entry in the "nexes" - object in the .nmf manifest file is a key-value pair: the key is the - instruction set architecture ('x86-32', 'x86-64', etc.); the value is a URL - for the desired NaCl module. - To load the debug versions of your .nexes, set the 'nacl' attribute to the - _dbg.nmf version of the manifest file. - - Note: Since this NaCl module does not use any real-estate in the browser, - its width and height are set to 0. - - Note: The <EMBED> element is wrapped inside a <DIV>, which has both a 'load' - and a 'message' event listener attached. This wrapping method is used - instead of attaching the event listeners directly to the <EMBED> element to - ensure that the listeners are active before the NaCl module 'load' event - fires. This also allows you to use PPB_Messaging.PostMessage() (in C) or - pp::Instance.PostMessage() (in C++) from within the initialization code in - your NaCl module. - --> - <div id="listener"> - <script type="text/javascript"> - var listener = document.getElementById('listener'); - listener.addEventListener('load', moduleDidLoad, true); - listener.addEventListener('message', handleMessage, true); - </script> - - <embed name="nacl_module" - id="<PROJECT_NAME>" - width=0 height=0 - src="<PROJECT_NAME>.nmf" - type="application/x-nacl" /> - </div> -</p> - -<h2>Status</h2> -<div id="status_field">NO-STATUS</div> -</body> -</html> diff --git a/native_client_sdk/src/project_templates/init_project.py b/native_client_sdk/src/project_templates/init_project.py deleted file mode 100755 index 0201fa7..0000000 --- a/native_client_sdk/src/project_templates/init_project.py +++ /dev/null @@ -1,505 +0,0 @@ -#!/usr/bin/env python -# Copyright (c) 2012 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -"""A simple project generator for Native Client projects written in C or C++. - -This script accepts a few argument which it uses as a description of a new NaCl -project. It sets up a project with a given name and a given primary language -(default: C++, optionally, C) using the appropriate files from this area. -This script does not handle setup for complex applications, just the basic -necessities to get a functional native client application stub. When this -script terminates a compileable project stub will exist with the specified -name, at the specified location. - -GetCamelCaseName(): Converts an underscore name to a camel case name. -GetCodeDirectory(): Decides what directory to pull source code from. -GetCodeSoureFiles(): Decides what source files to pull into the stub. -GetCommonSourceFiles(): Gives list of files needed by all project types. -GetHTMLDirectory(): Decides what directory to pull HTML stub from. -GetHTMLSourceFiles(): Gives HTML files to be included in project stub. -GetTargetFileName(): Converts a source file name into a project file name. -ParseArguments(): Parses the arguments provided by the user. -ReplaceInFile(): Replaces a given string with another in a given file. -ProjectInitializer: Maintains some state applicable to setting up a project. -main(): Executes the script. -""" - -__author__ = 'mlinck@google.com (Michael Linck)' - -import fileinput -import optparse -import os.path -import shutil -import sys -import uuid - -# A list of all platforms that should have make.cmd. -WINDOWS_BUILD_PLATFORMS = ['cygwin', 'win32'] - -# Tags that will be replaced in our the new project's source files. -PROJECT_NAME_TAG = '<PROJECT_NAME>' -PROJECT_NAME_CAMEL_CASE_TAG = '<ProjectName>' -SDK_ROOT_TAG = '<NACL_SDK_ROOT>' -NACL_PLATFORM_TAG = '<NACL_PLATFORM>' -VS_PROJECT_UUID_TAG = '<VS_PROJECT_UUID>' -VS_SOURCE_UUID_TAG = '<VS_SOURCE_UUID>' -VS_HEADER_UUID_TAG = '<VS_HEADER_UUID>' -VS_RESOURCE_UUID_TAG = '<VS_RESOURCE_UUID>' - -# This string is the part of the file name that will be replaced. -PROJECT_FILE_NAME = 'project_file' - -# Lists of source files that will be used for the new project. -COMMON_PROJECT_FILES = ['scons'] -C_SOURCE_FILES = ['build.scons', '%s.c' % PROJECT_FILE_NAME] -CC_SOURCE_FILES = ['build.scons', '%s.cc' % PROJECT_FILE_NAME] -HTML_FILES = ['%s.html' % PROJECT_FILE_NAME] -VS_FILES = ['%s.sln' % PROJECT_FILE_NAME, '%s.vcproj' % PROJECT_FILE_NAME] - -# Error needs to be a class, since we 'raise' it in several places. -class Error(Exception): - pass - - -def GetCamelCaseName(lower_case_name): - """Converts an underscore name to a camel case name. - - Args: - lower_case_name: The name in underscore-delimited lower case format. - - Returns: - The name in camel case format. - """ - camel_case_name = '' - name_parts = lower_case_name.split('_') - for part in name_parts: - if part: - camel_case_name += part.capitalize() - return camel_case_name - - -def GetCodeDirectory(is_c_project, project_templates_dir): - """Decides what directory to pull source code from. - - Args: - is_c_project: A boolean indicating whether this project is in C or not. - project_templates_dir: The path to the project_templates directory. - - Returns: - The code directory for the given project type. - """ - stub_directory = '' - if is_c_project: - stub_directory = os.path.join(project_templates_dir, 'c') - else: - stub_directory = os.path.join(project_templates_dir, 'cc') - return stub_directory - - -def GetCodeSourceFiles(is_c_project): - """Decides what source files to pull into the stub. - - Args: - is_c_project: A boolean indicating whether this project is in C or not. - - Returns: - The files that are specific to the requested type of project and live in its - directory. - """ - project_files = [] - if is_c_project: - project_files = C_SOURCE_FILES - else: - project_files = CC_SOURCE_FILES - return project_files - - -def GetCommonSourceFiles(): - """Gives list of files needed by all project types. - - Returns: - The files C and C++ projects have in common. These are the files that live - in the top level project_templates directory. - """ - project_files = COMMON_PROJECT_FILES - if sys.platform in WINDOWS_BUILD_PLATFORMS: - project_files.extend(['scons.bat']) - return project_files - - -def GetVsDirectory(project_templates_dir): - """Decides what directory to pull Visual Studio stub from. - - Args: - project_templates_dir: The path to the project_templates directory. - - Returns: - The directory where the HTML stub is to be found. - """ - return os.path.join(project_templates_dir, 'vs') - - -def GetVsProjectFiles(): - """Gives VisualStudio files to be included in project stub. - - Returns: - The VisualStudio files needed for the project. - """ - return VS_FILES - - -def GetHTMLDirectory(project_templates_dir): - """Decides what directory to pull HTML stub from. - - Args: - project_templates_dir: The path to the project_templates directory. - - Returns: - The directory where the HTML stub is to be found. - """ - return os.path.join(project_templates_dir, 'html') - - -def GetHTMLSourceFiles(): - """Gives HTML files to be included in project stub. - - Returns: - The HTML files needed for the project. - """ - return HTML_FILES - - -def GetTargetFileName(source_file_name, project_name): - """Converts a source file name into a project file name. - - Args: - source_file_name: The name of a file that is to be included in the project - stub, as it appears at the source location. - project_name: The name of the project that is being generated. - - Returns: - The target file name for a given source file. All project files are run - through this filter and it modifies them as needed. - """ - target_file_name = '' - if source_file_name.startswith(PROJECT_FILE_NAME): - target_file_name = source_file_name.replace(PROJECT_FILE_NAME, - project_name) - else: - target_file_name = source_file_name - return target_file_name - - -def GetDefaultProjectDir(): - """Determines the default project directory. - - The default directory root for new projects is called 'nacl_projects' under - the user's home directory. There are two ways to override this: you can set - the NACL_PROJECT_ROOT environment variable, or use the --directory option. - - Returns: - An os-specific path to the default project directory, which is called - 'nacl_projects' under the user's home directory. - """ - return os.getenv('NACL_PROJECT_ROOT', - os.path.join(os.path.expanduser('~'), 'nacl_projects')) - - -def ParseArguments(argv): - """Parses the arguments provided by the user. - - Parses the command line options and makes sure the script errors when it is - supposed to. - - Args: - argv: The argument array. - - Returns: - The options structure that represents the arguments after they have been - parsed. - """ - parser = optparse.OptionParser() - parser.add_option( - '-n', '--name', dest='project_name', - default='', - help=('Required: the name of the new project to be stubbed out.\n' - 'Please use lower case names with underscore, i.e. hello_world.')) - parser.add_option( - '-d', '--directory', dest='project_directory', - default=GetDefaultProjectDir(), - help=('Optional: If set, the new project will be created under this ' - 'directory and the directory created if necessary.')) - parser.add_option( - '-c', action='store_true', dest='is_c_project', - default=False, - help=('Optional: If set, this will generate a C project. Default ' - 'is C++.')) - parser.add_option( - '-p', '--nacl-platform', dest='nacl_platform', - default='pepper_17', - help=('Optional: if set, the new project will target the given nacl\n' - 'platform. Default is the most current platform. e.g. pepper_17')) - parser.add_option( - '--vsproj', action='store_true', dest='is_vs_project', - default=False, - help=('Optional: If set, generate Visual Studio project files.')) - result = parser.parse_args(argv) - options = result[0] - args = result[1] - #options, args) = parser.parse_args(argv) - if args: - parser.print_help() - sys.exit(1) - elif not options.project_name.islower(): - print('--name missing or in incorrect format. Please use -h for ' - 'instructions.') - sys.exit(1) - return options - - -class ProjectInitializer(object): - """Maintains the state of the project that is being created.""" - - def __init__(self, is_c_project, is_vs_project, project_name, - project_location, nacl_platform, project_templates_dir, - nacl_sdk_root=None, os_resource=os): - """Initializes all the fields that are known after parsing the parameters. - - Args: - is_c_project: A boolean indicating whether this project is in C or not. - is_vs_project: A boolean indicating whether this project has Visual - Studio support. - project_name: A string containing the name of the project to be created. - project_location: A path indicating where the new project is to be placed. - project_templates_dir: The path to the project_templates directory. - os_resource: A resource to be used as os. Provided for unit testing. - """ - self.__is_c_project = is_c_project - self.__is_vs_project = is_vs_project - self.__project_files = [] - self.__project_dir = None - self.__project_name = project_name - self.__project_location = project_location - self.__nacl_platform = nacl_platform - self.__project_templates_dir = project_templates_dir - # System resources are properties so mocks can be inserted. - self.__fileinput = fileinput - self.__nacl_sdk_root = nacl_sdk_root - self.__os = os_resource - self.__shutil = shutil - self.__sys = sys - self.__CreateProjectDirectory() - - def CopyAndRenameFiles(self, source_dir, file_names): - """Places files in the new project's directory and renames them as needed. - - Copies the given files from the given source directory into the new - project's directory, renaming them as necessary. Each file that is created - in the project directory is also added to self.__project_files. - - Args: - source_dir: A path indicating where the files are to be copied from. - file_names: The list of files that is to be copied out of source_dir. - """ - for source_file_name in file_names: - target_file_name = GetTargetFileName(source_file_name, - self.__project_name) - copy_source_file = self.os.path.join(source_dir, source_file_name) - copy_target_file = self.os.path.join(self.__project_dir, target_file_name) - self.shutil.copy(copy_source_file, copy_target_file) - self.__project_files += [copy_target_file] - - def __CreateProjectDirectory(self): - """Creates the project's directory and any parents as necessary.""" - self.__project_dir = self.os.path.join(self.__project_location, - self.__project_name) - if self.os.path.exists(self.__project_dir): - raise Error("Error: directory '%s' already exists" % self.__project_dir) - self.os.makedirs(self.__project_dir) - - def PrepareDirectoryContent(self): - """Prepares the directory for the new project. - - This function's job is to know what directories need to be used and what - files need to be copied and renamed. It uses several tiny helper functions - to do this. - There are three locations from which files are copied to create a project. - That number may change in the future. - """ - code_source_dir = GetCodeDirectory(self.__is_c_project, - self.__project_templates_dir) - code_source_files = GetCodeSourceFiles(self.__is_c_project) - html_source_dir = GetHTMLDirectory(self.__project_templates_dir) - html_source_files = GetHTMLSourceFiles() - common_source_files = GetCommonSourceFiles() - self.CopyAndRenameFiles(code_source_dir, code_source_files) - self.CopyAndRenameFiles(html_source_dir, html_source_files) - self.CopyAndRenameFiles(self.__project_templates_dir, - common_source_files) - if self.__is_vs_project: - vs_source_dir = GetVsDirectory(self.__project_templates_dir) - vs_files = GetVsProjectFiles() - self.CopyAndRenameFiles(vs_source_dir, vs_files) - print('init_project has copied the appropriate files to: %s' % - self.__project_dir) - - def PrepareFileContent(self): - """Changes contents of files in the new project as needed. - - Goes through each file in the project that is being created and replaces - contents as necessary. - """ - camel_case_name = GetCamelCaseName(self.__project_name) - sdk_root_dir = self.__nacl_sdk_root - if not sdk_root_dir: - raise Error("Error: NACL_SDK_ROOT is not set") - sdk_root_dir = self.os.path.abspath(sdk_root_dir) - if self.__is_vs_project: - project_uuid = str(uuid.uuid4()).upper() - vs_source_uuid = str(uuid.uuid4()).upper() - vs_header_uuid = str(uuid.uuid4()).upper() - vs_resource_uuid = str(uuid.uuid4()).upper() - for project_file in self.__project_files: - self.ReplaceInFile(project_file, PROJECT_NAME_TAG, self.__project_name) - self.ReplaceInFile(project_file, - PROJECT_NAME_CAMEL_CASE_TAG, - camel_case_name) - self.ReplaceInFile(project_file, SDK_ROOT_TAG, sdk_root_dir) - self.ReplaceInFile(project_file, NACL_PLATFORM_TAG, self.__nacl_platform) - if self.__is_vs_project: - self.ReplaceInFile(project_file, VS_PROJECT_UUID_TAG, project_uuid) - self.ReplaceInFile(project_file, VS_SOURCE_UUID_TAG, vs_source_uuid) - self.ReplaceInFile(project_file, VS_HEADER_UUID_TAG, vs_header_uuid) - self.ReplaceInFile(project_file, VS_RESOURCE_UUID_TAG, vs_resource_uuid) - - def ReplaceInFile(self, file_path, old_text, new_text): - """Replaces a given string with another in a given file. - - Args: - file_path: The path to the file that is to be modified. - old_text: The text that is to be removed. - new_text: The text that is to be added in place of old_text. - """ - for line in self.fileinput.input(file_path, inplace=1, mode='U'): - self.sys.stdout.write(line.replace(old_text, new_text)) - - # The following properties exist to make unit testing possible. - - def _GetFileinput(self): - """Accessor for Fileinput property.""" - return self.__fileinput - - def __GetFileinput(self): - """Indirect Accessor for _GetFileinput.""" - return self._GetFileinput() - - def _SetFileinput(self, fileinput_resource): - """Accessor for Fileinput property.""" - self.__fileinput = fileinput_resource - - def __SetFileinput(self, fileinput_resource): - """Indirect Accessor for _SetFileinput.""" - return self._SetFileinput(fileinput_resource) - - fileinput = property( - __GetFileinput, __SetFileinput, - doc="""Gets and sets the resource to use as fileinput.""") - - def _GetOS(self): - """Accessor for os property.""" - return self.__os - - def __GetOS(self): - """Indirect Accessor for _GetOS.""" - return self._GetOS() - - def _SetOS(self, os_resource): - """Accessor for os property.""" - self.__os = os_resource - - def __SetOS(self, os_resource): - """Indirect Accessor for _SetOS.""" - return self._SetOS(os_resource) - - os = property(__GetOS, __SetOS, - doc="""Gets and sets the resource to use as os.""") - - def _GetShutil(self): - """Accessor for shutil property.""" - return self.__shutil - - def __GetShutil(self): - """Indirect Accessor for _GetShutil.""" - return self._GetShutil() - - def _SetShutil(self, shutil_resource): - """Accessor for shutil property.""" - self.__shutil = shutil_resource - - def __SetShutil(self, shutil_resource): - """Indirect Accessor for _SetShutil.""" - return self._SetShutil(shutil_resource) - - shutil = property(__GetShutil, __SetShutil, - doc="""Gets and sets the resource to use as shutil.""") - - def _GetSys(self): - """Accessor for sys property.""" - return self.__sys - - def __GetSys(self): - """Indirect Accessor for _GetSys.""" - return self._GetSys() - - def _SetSys(self, sys_resource): - """Accessor for sys property.""" - self.__sys = sys_resource - - def __SetSys(self, sys_resource): - """Indirect Accessor for _SetSys.""" - return self._SetSys(sys_resource) - - sys = property(__GetSys, __SetSys, - doc="""Gets and sets the resource to use as sys.""") - - -def main(argv): - """Prepares the new project. - - Args: - argv: The arguments passed to the script by the shell. - """ - print 'init_project parsing its arguments.' - script_dir = os.path.abspath(os.path.dirname(__file__)) - options = ParseArguments(argv) - print 'init_project is preparing your project.' - # Check to see if the project is going into the SDK bundle. If so, issue a - # warning. - sdk_root_dir = os.getenv('NACL_SDK_ROOT', - os.path.dirname(os.path.dirname(script_dir))) - if sdk_root_dir: - if os.path.normpath(options.project_directory).count( - os.path.normpath(sdk_root_dir)) > 0: - print('WARNING: It looks like you are creating projects in the NaCl SDK ' - 'directory %s.\nThese might be removed at the next update.' % - sdk_root_dir) - project_initializer = ProjectInitializer(options.is_c_project, - options.is_vs_project, - options.project_name, - options.project_directory, - options.nacl_platform, - script_dir, - nacl_sdk_root=sdk_root_dir) - project_initializer.PrepareDirectoryContent() - project_initializer.PrepareFileContent() - return 0 - - -if __name__ == '__main__': - try: - sys.exit(main(sys.argv[1:])) - except Exception as error: - print error - sys.exit(1) diff --git a/native_client_sdk/src/project_templates/init_project_test.py b/native_client_sdk/src/project_templates/init_project_test.py deleted file mode 100755 index ae1d0b2..0000000 --- a/native_client_sdk/src/project_templates/init_project_test.py +++ /dev/null @@ -1,263 +0,0 @@ -#!/usr/bin/env python -# Copyright (c) 2012 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -"""Unit tests for init_project.py.""" - -__author__ = 'mlinck@google.com (Michael Linck)' - -import fileinput -import os -import shutil -import sys -import unittest -import mox -import init_project - - -def TestMock(file_path, open_func): - temp_file = open_func(file_path) - temp_file.close() - - -class TestGlobalFunctions(unittest.TestCase): - """Class for test cases to cover globally declared helper functions.""" - - def testGetCamelCaseName(self): - output = init_project.GetCamelCaseName('camel_case_name') - self.assertEqual(output, 'CamelCaseName') - output = init_project.GetCamelCaseName('print_42') - self.assertEqual(output, 'Print42') - - def testGetCodeDirectory(self): - output = init_project.GetCodeDirectory(True, '') - self.assertEqual(output, 'c') - output = init_project.GetCodeDirectory(False, '') - self.assertEqual(output, 'cc') - output = init_project.GetCodeDirectory(True, 'test') - self.assertEqual(output, 'test/c') - output = init_project.GetCodeDirectory(False, 'test') - self.assertEqual(output, 'test/cc') - - def testGetCodeSourceFiles(self): - output = init_project.GetCodeSourceFiles(False) - self.assertEqual(output, init_project.CC_SOURCE_FILES) - output = init_project.GetCodeSourceFiles(True) - self.assertEqual(output, init_project.C_SOURCE_FILES) - - def testGetCommonSourceFiles(self): - output = init_project.GetCommonSourceFiles() - expected_output_linux = init_project.COMMON_PROJECT_FILES - expected_output_windows = init_project.COMMON_PROJECT_FILES - expected_output_windows.extend(['scons.bat']) - linux_match = (output == expected_output_linux) - windows_match = (output == expected_output_windows) - passed = (linux_match | windows_match) - self.assertTrue(passed) - - def testGetHTMLDirectory(self): - output = init_project.GetHTMLDirectory('') - self.assertEqual(output, 'html') - output = init_project.GetHTMLDirectory('test') - self.assertEqual(output, 'test/html') - - def testGetHTMLSourceFiles(self): - output = init_project.GetHTMLSourceFiles() - self.assertEqual(output, init_project.HTML_FILES) - - def testGetTargetFileName(self): - output = init_project.GetTargetFileName('project_file.cc', 'bonkers') - self.assertEqual(output, 'bonkers.cc') - output = init_project.GetTargetFileName('constant.html', 'bonkers') - self.assertEqual(output, 'constant.html') - - def testParseArguments(self): - output = init_project.ParseArguments(['-n', 'test_name', '-d', 'test/dir']) - self.assertEqual(output.is_c_project, False) - self.assertEqual(output.project_name, 'test_name') - self.assertEqual(output.project_directory, 'test/dir') - output = init_project.ParseArguments(['-n', 'test_name_2', '-c']) - self.assertEqual(output.is_c_project, True) - self.assertEqual(output.project_name, 'test_name_2') - self.assertEqual(output.project_directory, - init_project.GetDefaultProjectDir()) - - -class TestProjectInitializer(unittest.TestCase): - """Class for test cases to cover public interface of ProjectInitializer.""" - - def __init__(self): - unittest.TestCase.__init__(self) - self.os_mock = None - self.fileinput_mock = None - self.sys_mock = None - self.shutil_mock = None - - def setUp(self): - self.script_dir = os.path.abspath(os.path.dirname(__file__)) - self.nacl_src_dir = os.getenv('NACL_SDK_ROOT', None) - self.mock_factory = mox.Mox() - # This mock is only valid for initialization and will be overwritten - # after ward by self.os_mock. - init_path_mock = self.mock_factory.CreateMock(os.path) - init_path_mock.join('test/dir', 'test_project').AndReturn( - 'test/dir/test_project') - init_path_mock.exists('test/dir/test_project').AndReturn(False) - init_os_mock = self.mock_factory.CreateMock(os) - init_os_mock.path = init_path_mock - init_os_mock.makedirs('test/dir/test_project') - self.mock_factory.ReplayAll() - self.test_subject = init_project.ProjectInitializer( - # True => is C project, False => is vs project - True, False, 'test_project', 'test/dir', 'pepper_14', self.script_dir, - self.nacl_src_dir, os_resource=init_os_mock) - self.mock_factory.VerifyAll() - self.InitializeResourceMocks() - - def InitializeResourceMocks(self): - """Can be called multiple times if multiple functions need to be tested.""" - self.fileinput_mock = self.mock_factory.CreateMock(fileinput) - self.test_subject.fileinput = self.fileinput_mock - self.os_mock = self.mock_factory.CreateMock(os) - self.test_subject.os = self.os_mock - self.shutil_mock = self.mock_factory.CreateMock(shutil) - self.test_subject.shutil = self.shutil_mock - self.sys_mock = self.mock_factory.CreateMock(sys) - self.test_subject.sys = self.sys_mock - - def testCopyAndRenameFiles(self): - self.shutil_mock.copy('source/dir/normal_name.txt', - 'test/dir/test_project/normal_name.txt') - self.shutil_mock.copy('source/dir/project_file.txt', - 'test/dir/test_project/test_project.txt') - self.os_mock.path = os.path - self.mock_factory.ReplayAll() - self.test_subject.CopyAndRenameFiles( - 'source/dir', ['normal_name.txt', 'project_file.txt']) - self.mock_factory.VerifyAll() - - def testPrepareDirectoryContent(self): - self.shutil_mock.copy( - '%s/c/build.scons' % self.script_dir, - 'test/dir/test_project/build.scons') - self.shutil_mock.copy( - '%s/c/project_file.c' % self.script_dir, - 'test/dir/test_project/test_project.c') - self.shutil_mock.copy( - '%s/html/project_file.html' % self.script_dir, - 'test/dir/test_project/test_project.html') - self.shutil_mock.copy( - '%s/scons' % self.script_dir, - 'test/dir/test_project/scons') - self.shutil_mock.copy( - '%s/scons.bat' % self.script_dir, - 'test/dir/test_project/scons.bat') - self.os_mock.path = os.path - self.mock_factory.ReplayAll() - self.test_subject.PrepareDirectoryContent() - self.mock_factory.VerifyAll() - - def testPrepareFileContent(self): - self.testCopyAndRenameFiles() - # We need a new set of resource mocks since the old ones have already been - # used. - self.InitializeResourceMocks() - path_mock = self.mock_factory.CreateMock(os.path) - stdout_mock = self.mock_factory.CreateMock(sys.stdout) - self.os_mock.path = path_mock - path_mock.abspath(self.nacl_src_dir).AndReturn(self.nacl_src_dir) - self.fileinput_mock.input( - 'test/dir/test_project/normal_name.txt', - inplace=1, mode='U').AndReturn( - ['A line with <PROJECT_NAME>.', - 'A line with <ProjectName>.', - 'A line with <NACL_SDK_ROOT>.', - 'A line with <NACL_PLATFORM>.']) - stdout_mock.write('A line with test_project.') - stdout_mock.write('A line with <ProjectName>.') - stdout_mock.write('A line with <NACL_SDK_ROOT>.') - stdout_mock.write('A line with <NACL_PLATFORM>.') - self.fileinput_mock.input( - 'test/dir/test_project/normal_name.txt', - inplace=1, mode='U').AndReturn( - ['A line with test_project.', - 'A line with <ProjectName>.', - 'A line with <NACL_SDK_ROOT>.', - 'A line with <NACL_PLATFORM>.']) - stdout_mock.write('A line with test_project.') - stdout_mock.write('A line with TestProject.') - stdout_mock.write('A line with <NACL_SDK_ROOT>.') - stdout_mock.write('A line with <NACL_PLATFORM>.') - self.fileinput_mock.input( - 'test/dir/test_project/normal_name.txt', - inplace=1, mode='U').AndReturn( - ['A line with test_project.', - 'A line with TestProject.', - 'A line with <NACL_SDK_ROOT>.', - 'A line with <NACL_PLATFORM>.']) - stdout_mock.write('A line with test_project.') - stdout_mock.write('A line with TestProject.') - stdout_mock.write('A line with %s.' % self.nacl_src_dir) - stdout_mock.write('A line with <NACL_PLATFORM>.') - self.fileinput_mock.input( - 'test/dir/test_project/normal_name.txt', - inplace=1, mode='U').AndReturn( - ['A line with test_project.', - 'A line with TestProject.', - 'A line with some/dir.', - 'A line with <NACL_PLATFORM>.']) - stdout_mock.write('A line with test_project.') - stdout_mock.write('A line with TestProject.') - stdout_mock.write('A line with some/dir.') - stdout_mock.write('A line with pepper_14.') - # One multi-line file with different replacements has already been mocked - # so we make this next test simpler. - self.fileinput_mock.input( - 'test/dir/test_project/test_project.txt', - inplace=1, mode='U').AndReturn(['A line with no replaceable text.']) - stdout_mock.write('A line with no replaceable text.') - self.fileinput_mock.input( - 'test/dir/test_project/test_project.txt', - inplace=1, mode='U').AndReturn(['A line with no replaceable text.']) - stdout_mock.write('A line with no replaceable text.') - self.fileinput_mock.input( - 'test/dir/test_project/test_project.txt', - inplace=1, mode='U').AndReturn(['A line with no replaceable text.']) - stdout_mock.write('A line with no replaceable text.') - self.fileinput_mock.input( - 'test/dir/test_project/test_project.txt', - inplace=1, mode='U').AndReturn(['A line with no replaceable text.']) - stdout_mock.write('A line with no replaceable text.') - self.sys_mock.stdout = stdout_mock - self.mock_factory.ReplayAll() - self.test_subject.PrepareFileContent() - self.mock_factory.VerifyAll() - - def testReplaceInFile(self): - self.fileinput_mock.input('test/path', inplace=1, mode='U').AndReturn( - ['A sentence replace_me.']) - stdout_mock = self.mock_factory.CreateMock(sys.stdout) - stdout_mock.write('A sentence with_this.') - self.sys_mock.stdout = stdout_mock - self.mock_factory.ReplayAll() - self.test_subject.ReplaceInFile('test/path', 'replace_me', 'with_this') - self.mock_factory.VerifyAll() - - -def RunTests(): - # It's possible to do this with one suite instead of two, but then it's - # harder to read the test output. - return_value = 1 - suite_one = unittest.TestLoader().loadTestsFromTestCase(TestGlobalFunctions) - result_one = unittest.TextTestRunner(verbosity=2).run(suite_one) - suite_two = unittest.TestLoader().loadTestsFromTestCase( - TestProjectInitializer) - result_two = unittest.TextTestRunner(verbosity=2).run(suite_two) - if result_one.wasSuccessful() and result_two.wasSuccessful(): - return_value = 0 - return return_value - - -if __name__ == '__main__': - sys.exit(RunTests()) diff --git a/native_client_sdk/src/project_templates/scons b/native_client_sdk/src/project_templates/scons deleted file mode 100755 index 17e9350..0000000 --- a/native_client_sdk/src/project_templates/scons +++ /dev/null @@ -1,47 +0,0 @@ -#!/bin/bash -# -# Copyright (c) 2011 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -readonly SCRIPT_DIR="$(dirname "$0")" -readonly SCRIPT_DIR_ABS="$(cd "${SCRIPT_DIR}" ; pwd -P)" -readonly SRC_DIR="$(dirname $(dirname $(dirname ${SCRIPT_DIR_ABS})))" - -# NACL_SDK_ROOT must be set. -if [ x"${NACL_SDK_ROOT}"x == "xx" ] ; then - echo "Error: NACL_SDK_ROOT is not set." - exit 1; -fi - -# NACL_TARGET_PLATFORM is really the name of a folder with the base dir - -# usually NACL_SDK_ROOT - within which the toolchain for the target platform -# are found. -# Replace the platform with the name of your target platform. For example, to -# build applications that target the pepper_17 API, set -# NACL_TARGET_PLATFORM="pepper_17" -if [ x"${NACL_TARGET_PLATFORM}"x == "xx" ] ; then - export NACL_TARGET_PLATFORM="pepper_17" -fi - -readonly NACL_PLATFORM_DIR="${NACL_SDK_ROOT}/${NACL_TARGET_PLATFORM}" - -SCONS_DIR="${NACL_PLATFORM_DIR}/third_party/scons-2.0.1" - -if [ ! -f ${SCONS_DIR}/script/scons ]; then - SCONS_DIR="${SRC_DIR}/third_party/scons-2.0.1" -fi - -BASE_SCRIPT="${SCONS_DIR}/script/scons" - -export SCONS_LIB_DIR="${SCONS_DIR}/engine" -export PYTHONPATH="${SCONS_LIB_DIR}" -export PYTHONPATH="${PYTHONPATH}:${NACL_PLATFORM_DIR}/build_tools" - -# We have to do this because scons overrides PYTHONPATH and does not preserve -# what is provided by the OS. The custom variable name won't be overwritten. -export PYMOX="${NACL_PLATFORM_DIR}/third_party/pymox/src" - -"${BASE_SCRIPT}" --file=build.scons \ - --site-dir="${SCRIPT_DIR_ABS}/../build_tools/nacl_sdk_scons" \ - $* diff --git a/native_client_sdk/src/project_templates/scons.bat b/native_client_sdk/src/project_templates/scons.bat deleted file mode 100755 index d56f245..0000000 --- a/native_client_sdk/src/project_templates/scons.bat +++ /dev/null @@ -1,50 +0,0 @@ -@echo off - -:: Copyright (c) 2011 The Chromium Authors. All rights reserved. -:: Use of this source code is governed by a BSD-style license that can be -:: found in the LICENSE file. - -setlocal - -:: NACL_SDK_ROOT must be set. -if not defined NACL_SDK_ROOT ( - echo Error: NACL_SDK_ROOT is not set. - echo Please set NACL_SDK_ROOT to the full path of the Native Client SDK. - echo For example: - echo set NACL_SDK_ROOT=D:\nacl_sdk - goto end -) - -:: NACL_TARGET_PLATFORM is really the name of a folder with the base dir - -:: usually NACL_SDK_ROOT - within which the toolchain for the target platform -:: are found. -:: Replace the platform with the name of your target platform. For example, to -:: build applications that target the pepper_17 API, set -:: NACL_TARGET_PLATFORM=pepper_17 -if not defined NACL_TARGET_PLATFORM ( - set NACL_TARGET_PLATFORM=pepper_17 -) - -set NACL_PLATFORM_DIR=%NACL_SDK_ROOT%\%NACL_TARGET_PLATFORM% - -set SCONS_DIR=%NACL_PLATFORM_DIR%\third_party\scons-2.0.1 -if exist %SCONS_DIR% goto gotscons -set SCONS_DIR=%~dp0..\..\..\third_party\scons-2.0.1 -:gotscons - -set SCONS_LIB_DIR=%SCONS_DIR%\engine -set PYTHONPATH=%SCONS_LIB_DIR%;%NACL_PLATFORM_DIR%\build_tools - -:: We have to do this because scons overrides PYTHONPATH and does not preserve -:: what is provided by the OS. The custom variable name won't be overwritten. -set PYMOX=%NACL_PLATFORM_DIR%\third_party\pymox\src - -set BASE_SCRIPT=%SCONS_DIR%\script\scons - -:: Run the included copy of scons. -python -O -OO %BASE_SCRIPT% ^ ---warn no-visual-c-missing ^ ---file=build.scons ^ ---site-dir="%~dp0..\build_tools\nacl_sdk_scons" %* - -:end diff --git a/native_client_sdk/src/project_templates/test.scons b/native_client_sdk/src/project_templates/test.scons deleted file mode 100644 index 56c3ac2..0000000 --- a/native_client_sdk/src/project_templates/test.scons +++ /dev/null @@ -1,26 +0,0 @@ -#! -*- python -*- -# -# Copyright (c) 2010 The Chromium Authors. All rights reserved. -# Use of this source code is governed by a BSD-style license that can be -# found in the LICENSE file. - -"""Build file for tests of init_project interface. - -Adapted from scons documentation: http://www.scons.org/wiki/UnitTests - -RunUnitTests(): Runs a comment and uses the return code to determine success. -""" - -__author__ = 'mlinck@google.com (Michael Linck)' - -import os -import sys - -Import('env') - -#TODO(mlinck) Enable this test again when it works on Windows -cmd = env.CreatePythonUnitTest(filename='init_project_test.py', - dependencies=['init_project.py'], - disabled=env['IS_WINDOWS']) - -env.AddNodeToTestSuite(cmd, ['bot'], 'run_init_project_test', 'small') diff --git a/native_client_sdk/src/project_templates/vs/project_file.sln b/native_client_sdk/src/project_templates/vs/project_file.sln deleted file mode 100644 index 05f5169..0000000 --- a/native_client_sdk/src/project_templates/vs/project_file.sln +++ /dev/null @@ -1,20 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 10.00 -# Visual Studio 2008 -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "<PROJECT_NAME>", "<PROJECT_NAME>.vcproj", "{<VS_PROJECT_UUID>}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Win32 = Debug|Win32 - Release|Win32 = Release|Win32 - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {<VS_PROJECT_UUID>}.Debug|Win32.ActiveCfg = Debug|Win32 - {<VS_PROJECT_UUID>}.Debug|Win32.Build.0 = Debug|Win32 - {<VS_PROJECT_UUID>}.Release|Win32.ActiveCfg = Release|Win32 - {<VS_PROJECT_UUID>}.Release|Win32.Build.0 = Release|Win32 - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal diff --git a/native_client_sdk/src/project_templates/vs/project_file.vcproj b/native_client_sdk/src/project_templates/vs/project_file.vcproj deleted file mode 100644 index d2b0f25..0000000 --- a/native_client_sdk/src/project_templates/vs/project_file.vcproj +++ /dev/null @@ -1,184 +0,0 @@ -<?xml version="1.0" encoding="Windows-1252"?> -<VisualStudioProject - ProjectType="Visual C++" - Version="9.00" - Name="<PROJECT_NAME>" - ProjectGUID="{<VS_PROJECT_UUID>" - RootNamespace="<PROJECT_NAME>" - Keyword="MakeFileProj" - TargetFrameworkVersion="196613" - > - <Platforms> - <Platform - Name="Win32" - /> - </Platforms> - <ToolFiles> - </ToolFiles> - <Configurations> - <Configuration - Name="Debug|Win32" - OutputDirectory="$(ConfigurationName)" - IntermediateDirectory="$(ConfigurationName)" - ConfigurationType="0" - > - <Tool - Name="VCNMakeTool" - BuildCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons" - ReBuildCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons -c && $(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons" - CleanCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons -c" - Output="<PROJECT_NAME>_x86_64_dbg.nexe" - PreprocessorDefinitions="WIN32;_DEBUG" - IncludeSearchPath="" - ForcedIncludes="" - AssemblySearchPath="" - ForcedUsingAssemblies="" - CompileAsManaged="" - /> - </Configuration> - <Configuration - Name="Release|Win32" - OutputDirectory="$(ConfigurationName)" - IntermediateDirectory="$(ConfigurationName)" - ConfigurationType="0" - > - <Tool - Name="VCNMakeTool" - BuildCommandLine="" - ReBuildCommandLine="" - CleanCommandLine="" - Output="<PROJECT_NAME>.exe" - PreprocessorDefinitions="WIN32;NDEBUG" - IncludeSearchPath="" - ForcedIncludes="" - AssemblySearchPath="" - ForcedUsingAssemblies="" - CompileAsManaged="" - /> - </Configuration> - </Configurations> - <References> - </References> - <Files> - <Filter - Name="Source Files" - Filter="cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx" - UniqueIdentifier="{<VS_SOURCE_UUID>}" - > - <File - RelativePath=".\build.scons" - > - </File> - <File - RelativePath=".\<PROJECT_NAME>.cc" - > - </File> - </Filter> - <Filter - Name="Header Files" - Filter="h;hpp;hxx;hm;inl;inc;xsd" - UniqueIdentifier="{<VS_HEADER_UUID>}" - > - </Filter> - <Filter - Name="Resource Files" - Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav" - UniqueIdentifier="{<VS_RESOURCE_UUID>}" - > - </Filter> - </Files> - <Globals> - </Globals> -</VisualStudioProject> -<?xml version="1.0" encoding="Windows-1252"?> -<VisualStudioProject - ProjectType="Visual C++" - Version="9.00" - Name="<PROJECT_NAME>" - ProjectGUID="{<VS_PROJECT_UUID>" - RootNamespace="<PROJECT_NAME>" - Keyword="MakeFileProj" - TargetFrameworkVersion="196613" - > - <Platforms> - <Platform - Name="Win32" - /> - </Platforms> - <ToolFiles> - </ToolFiles> - <Configurations> - <Configuration - Name="Debug|Win32" - OutputDirectory="$(ConfigurationName)" - IntermediateDirectory="$(ConfigurationName)" - ConfigurationType="0" - > - <Tool - Name="VCNMakeTool" - BuildCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons" - ReBuildCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons -c && $(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons" - CleanCommandLine="$(NACL_SDK_ROOT)\<NACL_PLATFORM>\examples\scons -c" - Output="<PROJECT_NAME>_x86_64_dbg.nexe" - PreprocessorDefinitions="WIN32;_DEBUG" - IncludeSearchPath="" - ForcedIncludes="" - AssemblySearchPath="" - ForcedUsingAssemblies="" - CompileAsManaged="" - /> - </Configuration> - <Configuration - Name="Release|Win32" - OutputDirectory="$(ConfigurationName)" - IntermediateDirectory="$(ConfigurationName)" - ConfigurationType="0" - > - <Tool - Name="VCNMakeTool" - BuildCommandLine="" - ReBuildCommandLine="" - CleanCommandLine="" - Output="<PROJECT_NAME>.exe" - PreprocessorDefinitions="WIN32;NDEBUG" - IncludeSearchPath="" - ForcedIncludes="" - AssemblySearchPath="" - ForcedUsingAssemblies="" - CompileAsManaged="" - /> - </Configuration> - </Configurations> - <References> - </References> - <Files> - <Filter - Name="Source Files" - Filter="cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx" - UniqueIdentifier="{<VS_SOURCE_UUID>}" - > - <File - RelativePath=".\build.scons" - > - </File> - <File - RelativePath=".\<PROJECT_NAME>.cc" - > - </File> - </Filter> - <Filter - Name="Header Files" - Filter="h;hpp;hxx;hm;inl;inc;xsd" - UniqueIdentifier="{<VS_HEADER_UUID>}" - > - </Filter> - <Filter - Name="Resource Files" - Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav" - UniqueIdentifier="{<VS_RESOURCE_UUID>}" - > - </Filter> - </Files> - <Globals> - </Globals> -</VisualStudioProject> |