diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 62592f54ee..8d37ea66a8 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -4,6 +4,15 @@ KiCad ChangeLog 2010 Please add newer entries at the top, list the date and your name with email address. +2010-Dec-13 UPDATE Dick Hollenbeck +================================================================================ +++eeschema: + Committed a new design for a "Distributed Library Managment System". + To make the html docs, run doxygen in /new with that as your + current working directory, or run the shell script in there. You need + Doxygen installed. + + 2010-dec-13 UPDATE Wayne Stambaugh ================================================================================ ++common diff --git a/new/Doxyfile b/new/Doxyfile new file mode 100644 index 0000000000..e6b11073e4 --- /dev/null +++ b/new/Doxyfile @@ -0,0 +1,1552 @@ +# Doxyfile 1.6.3 + +# 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 = "Distributed Library & EESchema Parts List Design" + +# 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 = . + +# 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 = NO + +# 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 is your file systems +# 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 = 4 + +# 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 = NO + +# 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, C#, 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 make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# 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 to 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 rougly 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 = NO + +# 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 = YES + +# 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 namespace 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = NO + +# 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 = YES + +# 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 = NO + +# 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 define 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 defines 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 = YES + +# 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 , where is the value of +# the FILE_VERSION_FILTER tag, and 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 + +# This WARN_NO_PARAMDOC option can be abled 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 = NO + +# 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 = . + +# 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++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h \ + *.cpp + +# 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 = + +# 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 = + +# 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 , where +# is the value of the INPUT_FILTER tag, and 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 = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = YES + +# 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 = NO + +# 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 = YES + +# 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 = YES + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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 = + +# 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 = + +# 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 = + +# 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 = YES + +# 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 = YES + +# 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 + +# 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 +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +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 [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +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 = YES + +# 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 = 250 + +# 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 + +# 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 disadvances is 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 = . + +# 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, a4wide, 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 = NO + +# 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 = NO + +# 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 = *.h + +# 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 = + +# 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 is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# 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 + +# 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 + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will 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 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 = 0 + +# 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 = NO + +# 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/new/design.h b/new/design.h index 79fc96f431..c8b1db2537 100644 --- a/new/design.h +++ b/new/design.h @@ -1,42 +1,427 @@ -// This file describes the early phases of some new classes which may -// eventually be used to implement a distributed library system. +/** @mainpage -// Designer and copyright holder: Dick Hollenbeck +This file describes the design of a new Distributed Library System for Kicad's +EESCHEMA. Many of the concepts can be adapted with modest modification to PCBNEW +also, in the future. +@author Dick Hollenbeck + +@date October-December 2010 + +@section intr_sec Introduction + +Schematic parts are frequently needed to complete a circuit design +schematic. Computer data entry of parts can be a rate limiting step in the +design of an overall PCB. Having ready made access to all needed parts in a +design significantly improves the productivity of a circuit designer. Sharing +parts within an organization is one step in the right direction, but there is +opportunity to share across organizational boundaries to improve productivity +even more. Using a part that someone else in another organization has already +entered into the computer can eliminate the first data input process for that +part. The more complicated the part and the board, the larger the positive +impact on productivity because the larger the time savings. + +

Sharing parts within an organization is best done by directly accessing a +known internal source for those parts, say on a company network. Sharing parts +across organizational boundaries is best done using the Internet in real-time. +Having the ability to search for a part based on arbitrary search criteria can +speed up the pace at which new parts are found and used. + +

Electronic component manufacturers need and look for ways to differentiate +their products from their competitors. With this Distributed Library System +facility in Kicad, one way for manufacturers to differentiate themselves and +their parts is to publish a part library on the Internet and save their +customers the work of doing the data entry of the part into the Kicad design +system. + +

Maintaining a comprehensive part library is a fairly labor intensive +activity. New parts come into the market everyday. By being able to publish a +superior library on the Internet, it may be possible to make a for profit +business out of doing this. The Kicad eco-system would benefit should this +happen, and there could even be competition between such businesses. Or there +can be library specializations or niches. + +

Often a found part is close to what is needed but not exactly what is +needed. This Distributed Library System design incorporates the concept of part +inheritance using a part description language called Sweet. Sweet is +based on s-expression syntax. Inheritance is the ability to incrementally change +an existing part without completely re-designing it. It is sometimes easier to +modify an existing part than it is to create the new part entirely from scratch. + +

This Distributed Library System design will have the capability to +significantly benefit the Kicad eco-system, and that should mean expanding the +numbers of users and contributors to the project, and hopefully making for a +better Kicad tool-set for all. + + +@section definitions Definitions + +Only new terms or changes in the definition of terms are given here. + +

+ +
S-Expression
This is a syntactical textual envelop in the same vain as +XML. It may be used to express any number of domain specific grammars. It uses +parentheses to indicate the start and end of an element. A domain specific +grammar is a set of rules that dictate what keywords may be used, and in what +context. A grammar also establishes the allowed places and types of constants. +There can be any number of grammars which all use s-expressions to hold the +individual elements within the grammar. A grammar is at a higher level than +s-expressions, in the same way that a sentence will have grammatical rules which +are at a higher level than the rules used to spell words. Technically, grammars +nest within grammars. So once you are inside a grammatical element, it will have +its own set of rules as to which nested elements it may hold, and once you enter +one of those nested elements, then that nested element's grammar pertains, +etc.

In the case of the grammar for a part, the grammar itself is being given +the name Sweet. The name does not extend to the grammar for the schematic, +only the part grammar.

+ +
Schematic
This consists of one or more sheets and will be different +in three ways from existing schematics.
    + +
  • All sheets will be in one file, thus the entire schematic is in one file. + +
  • The schematic file will have its own s-expression grammar. + +
  • There will be a parts list within the schematic, and within the + parts list will be all the parts for the schematic. yes all of + them. See class PARTS_LIST.
+ +Within the sheets of the schematic will be components.
+ +
Component
A component is an instantiated part. The keyword for +component is (comp). A component does not have any of its own properties other +than:
  • rerence designator
  • part pointer or reference into the parts +list
  • location
  • rotation
  • stuff i.e. DNS or do stuff the part +
  • visual textual effect overrides
Note that the (comp) may not have any +properties or fields of its own, and that it may not exist without a +corresponding part in the parts_list. A reason for this is to ensure that a +BOM can be made simply from the parts_list.
+ +
Component, again for good measure.
A component is an instantiation +of a part. A component exists within a schematic which has a parts list +containing the part from which the component is instantiated. A component has a +unique reference designator, component ref, its own location, orientation, +stuff/DNS, and text attributes but not its own text fields/strings (other +than reference designator). The part which is instantiated must exist in the +parts list of the same schematic.
+ +
Inheritance
Is the ability to mimic form and function from another +entity. In our case we use it only for parts. One part may "inherit from" or +"extend" another single part.
+ +
Part
A part is a symbolic schematic circuit element found within an +EESCHEMA library (or within a parts list). It is re-usable and may be +instantiated more than once within a schematic. For it to be instantiated, it +must be copied or inherited into the parts list of the instantiating schematic. +If inherited into the parts list, then only a concise reference is needed into +the originating library. If instead it is copied into the parts list, then the +part is fully autonomous and need have no reference to its original copy.
+ +
Parts List
A parts list, keyword (parts_list), is an entirely new +construct. It exists within a schematic and is the complete set of parts used +within a particular schematic. Each schematic has exactly one parts list +contained within it. A parts list is also a library source and a library sink +for the current schematic. A parts list in any schematic may also be a library +source for any other schematic, but not a library sink. The parts list construct +makes it almost wholly unnecessary to write to other types of library +sinks.
+ +
Library
A library is no longer a file. It is a memory cache of +parts, consistent with the normal definition of memory cache. Each library is +backed up with a library source. In rare cases, some libraries may also +have a library sink.
+ +
Library Source
A library source is an abstract read only repository +of parts. The repository itself might exist on the moon. The difference between +a library source and a library sink is that a source is a readable entity.
+ +
Library Sink
A library sink is an abstract place that parts can be +written to for future reading. The difference between a library source and a +library sink is that a library sink is a writable entity.
+ +
Symbol
The term "symbol" is not used in a specific way in this +document. There is no symbol in any of the grammars, so use of it on the +developers list will not be understood without explanation. Of course it is +possible to have multiple parts all extend a common base part, and you can think +of the base part as having most if not all the graphical lines for any +derivatives. But we do not need to use the term symbol to describe that +relationship, the term "part" is sufficient.
+ +
LPID
This stand for "Logical Part ID", and is a reference to any +part within any known library. The term "logical" is used because the contained +library name is logical, not a full library name. The LPID consists of 3 main +portions: logical library name, part name, and revision number.
+ +
Library Table
This is a lookup table that maps a logical library +name (i.e. a short name) into a fully specified library name and library type. +An applicable library table consists of rows from (at least) two sources:
    +
  1. A schematic resident library table. +
  2. A personal library table. +
+ +These rows from the two sources are conceptually concatonated (although they may +not be physically concatonated in the implementation, TBD). The schematic +resident rows take presedence over the personal library table if there are +logicl library names duplicately defined. (Or we will simply ask that any remote +(i.e. public) libraries use uppercase first letters in logical names, TBD.) + +

Eventually there will be an external publicly available internet based +logical library table also, but this will need to be glued down at a hard coded +URL that we have control over. The internet based library table allows us to +advertise remote libraries without having to issue an update to Kicad.

+ +
Query Language
This is a means of searching for something that is +contained within a container. Since some library sources are remote, it is +important to be able to ask the library source for a part that matches some +criteria, for performance reasons.
+ +
+ + + +@section changes Required Changes + +In order fulfill the vision embodied by this Distributed Library System design, +it will be necessary to change many APIs and file formats within EESCHEMA. In +fact, the entire schematic file format will be new, based on s-expressions, +the schematic grammar, and the Sweet language for parts. + +Here are some of the changes required:
    + +
  • All sheets which make up a schematic will go into a single s-expression +file. The multiple sheet support will still exist, but all the sheets for a +single schematic are all in a single file. + +
  • A "library" is a collection of "parts". The unit of retrieval from a +library is a part as a textual string in the Sweet language. Sweet is a +particular "grammar" expressed in s-expression form, and can be used to fully +describe parts. Because EESCHEMA does not actually see a "library file", +(remember, EESCHEMA can only ask for a part), the actual file format for a +library is no longer pertinent nor visible to the core of EESCHEMA. The unit of +retrieval from the API is the part, so EESCHEMA gets an entire part s-expression +and must then parse it as a RAM resident Sweet string. + +
  • EESCHEMA knows of no library files, instead there is a library API which +abstracts the actual part storage strategy used within any library +implementation. The API can be implemented by anyone wanting to provide a +library under a given storage strategy. The API provides a storage strategy +abstraction in classes LIB_SOURCE and LIB_SINK. The actual storage strategy used +in any particular library implementation is not technically part of the +conceptual core of EESCHEMA. This is an important concept to grasp. Eventually +the library implementations may be jetisoned into a plug-in structure, but +initially they are statically linked into EESCHEMA. Should the plug-in strategy +ever get done, the boundary of the plug-in interface will remain the C++ library +API as given here (mostly in class LIB_SOURCE). The only reason to introduce a +plug-in design is to allow proprietary closed source library implementations, +and this could eventually come about if a part vendor wanted to provide one for +the Kicad project. If a Texas Instruments type of company wants to maintain a +Kicad library, we will be positioned to accommodate them. Until then, the +LIB_SOURCE implementations can be statically linked into EESCHEMA and there is +no conceptual disruption either way. + +
  • Most library implementations are read only. There are only two library +types that are writable, the "dir" type, and the "parts list". All other types +are read only from the perspective of the API. Stuffing those read only +libraries and maintaining them will be done using the normal update mechanisms +pertinent to the library's respective type of repository. The most common place +to do incremental enhancements to a part before using it is not in the external +library, but now in the parts list with this new design. + +
  • The design will support classical clipboard usage. The part in the Sweet +language can be placed onto the clipboard for use by other applications and +instances of EESCHEMA. Eventually larger blocks of components may also be +supported on the clipboard, since the Sweet language allows these blocks to be +descributed textually in a very readable fashion. (Clipboard support beyond part +manipulation is not currently in this revision of the design however, it can be +a future separate enhancement. Perhaps someday complete sheets may be passed +through the clipboard.) + +
  • The cumulative set of required changes are significant, and are tantamount +to saying that EESCHEMA will need its part handling foundations re-written. A +conversion program will convert everything over to the new architecture. The +conversion program can simplify things by simply putting all schematic parts +into a parts list within each schematic. + +
  • An Internet connection is required to use some of the library sources. It +will be possible to omit these library sources and run Kicad by doing a +configuration change. Eventually, some library sources will spring up and will +not technically be part of the Kicad project, so they will remain remote, but +fully usable to those with an internet connection and permission from the +library source's owner. + +
  • By far, even as radical as the distributed library concept is, complete with +remote access, the most significant conceptual change is the introduction of the +parts list. This is a special library that exists in a schematic, and is +the complete record of all parts used within that same schematic. It is +impossible to put a component into a schematic without that component's part +first existing within the parts list of that schematic. + +
  • Because of inheritance, multi-body-form parts, alternate body styles, see +also references, and other needs, it is necessary to have a part reference +mechanism. A component has to reference a part, the one it "is". A part has +to be able to reference another part, either in the same library or elsewhere. +Enter the Logical Part ID, or LPID to serve this need. An LPID consists of a +logical library name, a part name, and an optional revision. It is used to +reference parts, from anywhere. If the reference is from a sheet's component, +then the logical library name of the LPID is not needed. Why? Well if you've +been paying attention you know. A comp can only be based on a part that exists +within the parts_list of the same schematic in which it resides. Likewise, a +part within any library that references another part in that same library +will also omit the logical library name from the LPID, and it must omit it. Why? +Well because it makes renaming the library easier, for one. Two, the logical +library name is only a lookup key into a "library table". The library table maps +the logical library name into an actual library source [and sink, iff writable]. +See LIB_SOURCE and LIB_SINK. + +

    In the case of the component referencing the part that it "is", there is no +revision number allowed in the LPID. This is because that reference is to the +part in the parts list, and the parts list only holds a single revision of any +part (where "revision" is what you understand from version control systems). + +

  • There needs to be a new query language designed and each library source +needs to support it. See LIB_SOURCE::FindParts() for a brief description of one. + +
+ + +@section philosophy Design Philosophies + +

Class names are chosen to be as concise as possible. Separate namespaces can be +used should these same class names be needed in both EESCHEMA and PCBNEW (later). +However, this design does not yet address PCBNEW. Suggested namespaces are +SCH for EESCHEMA, and PCB for PCBNEW. + +

Since most if not all the APIs deal with file or non-volatile storage, only +8 bit string types are used. For international strings, UTF-8 is used, and +that is what is currently in use within the Kicad file storage formats. + +

The typedef STRINGS is used frequently as a holder for multiple +std::strings. After some research, I chose std::dequeue to hold a list of +STRINGs. I thought it best when considering overall speed, memory +fragmentation, memory efficiency, and speed of insertion and expansion. + +

A part description language is introduced called (Sweet). It supports +inheritance and its syntax is based on s-expressions. + +

Since a part can be based on another part using inheritance, it is important +to understand the idea of library dependencies. A part in one library can be +dependent on another part in another library, or on another part in the same +library as itself. There are several library sources, some far away and some +very close to the schematic. The closest library to the schematic is the +(parts list) class PARTS_LIST. Circular dependencies are not allowed. All +dependencies must be resolvable in a straight forward way. This means that a +part in a remote library cannot be dependent on any part which is not always +resolvable. + +

NRVO described: + http://msdn.microsoft.com/en-us/library/ms364057%28VS.80%29.aspx + +Even with NRVO provided by most C++ compilers, I don't see it being as lean as +having class LIB keep expanded members STRING fetch and STRINGS vfetch for the +aResults values. But at the topmost API, client convenience is worth a minor +sacrifice in speed, so the topmost API does return these complex string objects +for convenience. So there is a different strategy underneath the hood than what +is used on the hood ornament. When aResults pointer is passed as an argument, I +won't refer to this as 'returning' a value, but rather 'fetching' a result to +distinguish between the two strategies. + + +@section architecture Architecture + +This document set later shows some library sources derived from class +LIB_SOURCE. A library source is the backing to a library. The class name for a +library in the new design is LIB. + +

+Show architecture here. + + Click here to see an architectural drawing. + +*/ + + + +/** + * \defgroup string_types STRING Types + * Provide some string types for use within the API. + * @{ + */ typedef std::string STRING; -typedef std::vector< STRING > STRINGS; + +/** + * Type STRING_TOKS + * documents a container which holds a sequence of s-expressions suitable for parsing + * with DSNLEXER. This can either be a sequence of DSN_SYMBOLs or a sequence of + * fully parenthesis delimited s-expressions. There are 2 types:

    + *
  1. R C R33 "quoted-name" J2 + *
  2. (part R ())(part C ()) + *
+ * Notice that in the 1st example, there are 5 tokens in sequence, and in the + * 2nd example there are two top most s-expressions in sequence. So the counts + * in these are 5 and 2 respectively. + */ +typedef std::dequeue STRING_TOKS; + +typedef std::dequeue STRINGS; + +//typedef std::vector WSTRINGS; const STRING StrEmpty = ""; +/** @} string_types STRING Types */ + +/** + * \defgroup exception_types Exception Types + * Provide some exception types for use within the API. + * @{ + */ + +/** + * Class PARSE_ERROR + * contains a filename or source description, a line number, a character offset, + * and an error message. + */ +struct PARSE_ERROR : public IO_ERROR +{ +}; + +/** @} exception_types Exception Types */ + +namespace SCH { + /** * Class PART * will have to be unified with what Wayne is doing. I want a separate copy + * here until I can get the state management correct. Since a PART only lives - * within a cache called a LIBRARY, its constructor is private (only a LIBRARY + * within a cache called a LIB, its constructor is private (only a LIB * can instantiate one), and it exists in various states of freshness and - * completeness relative to the LIBRARY_SOURCE within the LIBRARY. + * completeness relative to the LIB_SOURCE within the LIB. */ class PART { - /// LIBRARY class has great license to modify what's in here, nobody else does. - /// Modification is done through the LIBRARY so it can track the state of the + /// LIB class has great license to modify what's in here, nobody else does. + /// Modification is done through the LIB so it can track the state of the /// PART and take action as needed. Actually most of the modification will - /// be done by PARTS_LIST, a class derived from LIBRARY. - friend class LIBRARY; + /// be done by PARTS_LIST, a class derived from LIB. + friend class LIB; - /// a private constructor, only a LIBRARY can instantiate one. + /// a private constructor, only a LIB can instantiate a PART. PART() {} -protected: // not likely to have descendants, but protected none-the-less. +protected: // not likely to have C++ descendants, but protected none-the-less. - LIBRARY* owner; ///< which LIBRARY am I a part of (pun if you want) + bool parsed; ///< true if the body as been parsed already. + + LIB* owner; ///< which LIB am I a part of (pun if you want) STRING extends; ///< LPID of base part STRING name; ///< example "passives/R", immutable. @@ -45,7 +430,17 @@ protected: // not likely to have descendants, but protected none-the-less. /// actually becomes cached in RAM. STRING body; - // lots of other stuff. + // 3 separate lists for speed: + + /// A property list. + + /// A drawing list for graphics + + /// A pin list + + /// Alternate body forms. + + // lots of other stuff, like the mandatory properties. public: @@ -53,10 +448,25 @@ public: /** * Function Inherit * is a specialized assignment function that copies a specific subset, enough - * to fulfill the requirements of the sweet s-expression language. + * to fulfill the requirements of the Sweet s-expression language. */ void Inherit( const PART& aBasePart ); + + /** + * Function Owner + * returns the LIB* owner of this part. + */ + LIB Owner() { return owner; } + + /** + * Function Parse + * translates the \a body string into a binary form that is represented + * by the normal fields of this class. Parse is expected to call Inherit() + * if this part extends any other. + */ + void Parse( DSN_LEXER* aLexer ) throw( PARSE_EXCEPTION ); + }; @@ -64,7 +474,7 @@ public: * Class LPID (aka GUID) * is a Logical Part ID and consists of various portions much like a URI. It * relies heavily on a logical library name to hide where actual physical library - * sources reside. Its static functions serve as managers of the library table to + * sources reside. Its static functions serve as managers of the "library table" to * map logical library names to actual library sources. *

* Example LPID string: @@ -79,12 +489,12 @@ public: * *

* This class owns the library table, which is like fstab in concept and maps logical - * library name to library URI, type, and password. It has the following columns: + * library name to library URI, type, and options. It has the following columns: *

    *
  • Logical Library Name *
  • Library Type - *
  • Library URI - *
  • Password + *
  • Library URI. The full URI to the library source, form dependent on Type. + *
  • Options, used for access, such as password *
*

* For now, the Library Type can be one of: @@ -94,6 +504,7 @@ public: *

  • "subversion" *
  • "bazaar" *
  • "http" + * *

    * For now, the Library URI types needed to support the various types can be one of those * shown below, which are typical of each type: @@ -102,20 +513,28 @@ public: *

  • "file://home/user/kicadwork/jtagboard.sch" *
  • "svn://kicad.org/partlib/trunk" *
  • "http://kicad.org/partlib" + * *

    - * The library table is built up from several sources, and is a contatonation - * of those sources. + * The applicable library table is built up from several additive rows (table fragments), + * and the final table is a merging of the table fragments. Two anticipated sources of + * the rows are a personal table, and a schematic resident table. The schematic + * resident table rows are considered a higher priority in the final dynamically + * assembled library table. A row in the schematic contribution to the library table + * will take precedence over the personal table if there is a collision on logical + * library name, otherwise the rows simply combine without issue to make up the + * applicable library table. */ class LPID // aka GUID { +public: /** * Constructor LPID * takes aLPID string and parses it. A typical LPID string uses a logical * library name followed by a part name. * e.g.: "kicad:passives/R/rev2", or - * e.g.: "me:R33" + * e.g.: "mylib:R33" */ - LPID( const STRING& aLPID = StrEmpty ) throw( PARSE_ERROR ); + LPID( const STRING& aLPID ) throw( PARSE_ERROR ); /** * Function GetLogLib @@ -165,53 +584,57 @@ class LPID // aka GUID * Function GetLogicalLibraries * returns the logical library names, all of them that are in the * library table. + * @param aSchematic provides access to the full library table inclusive + * of the schematic contribution, or may be NULL to exclude the schematic rows. */ - static STRINGS GetLogicalLibraries(); + static STRINGS GetLogicalLibraries( SCHEMATIC* aSchematic=NULL ); /** * Function GetLibraryURI * returns the full library path from a logical library name. + * @param aLogicalLibraryName is the short name for the library of interest. + * @param aSchematic provides access to the full library table inclusive + * of the schematic contribution, or may be NULL to exclude the schematic rows. */ - static STRING GetLibraryURI( const STRING& aLogicalLibraryName ) const; + static STRING GetLibraryURI( const STRING& aLogicalLibraryName, + SCHEMATIC* aSchematic=NULL ) const; /** * Function GetLibraryType * returns the type of a logical library. + * @param aLogicalLibraryName is the short name for the library of interest. + * @param aSchematic provides access to the full library table inclusive + * of the schematic contribution, or may be NULL to exclude the schematic rows. */ - static STRING GetLibraryType( const STRING& aLogicalLibraryName ) const; + static STRING GetLibraryType( const STRING& aLogicalLibraryName, + SCHEMATIC* aSchematic=NULL ) const; /** - * Function GetPassword - * returns the password for this type of a logical library. + * Function GetOptions + * returns the options string for \a aLogicalLibraryName. + * @param aLogicalLibraryName is the short name for the library of interest. + * @param aSchematic provides access to the full library table inclusive + * of the schematic contribution, or may be NULL to exclude the schematic rows. */ - static STRING GetPassword( const STRING& aLogicalLibraryName ) const; + static STRING GetPassword( const STRING& aLogicalLibraryName, + SCHEMATIC* aSchematic=NULL ) const; }; /** - * Class LIBRARY_SOURCE - * is an abstract class from which implementation specific LIBRARY_SOURCEs + * Class LIB_SOURCE + * is an abstract class from which implementation specific LIB_SOURCEs * may be derived, one for each kind of library type allowed in the library table. * The class name stems from the fact that this interface only provides READ ONLY * functions. */ -class LIBRARY_SOURCE +class LIB_SOURCE { - friend class LIBRARY; ///< only the LIBRARY uses these functions. + friend class LIBS; ///< the LIB factory is LIBS::GetLibrary() + friend class LIB; ///< the LIB uses these functions. protected: ///< derived classes must implement - /* - NRVO described: - http://msdn.microsoft.com/en-us/library/ms364057%28VS.80%29.aspx - - Even with NRVO provided by the compilers, I don't see it being as lean as - having the LIBARY keep an expanded member STRING for the aResult value. So I - am heading towards passing STRING* aResult and STRINGS* aResults. Rather - than returning a STRING. When the pointer to a results buffer is passeed, - I won't refer to this as returning a value, but rather 'fetching' a result. - */ - /** * Function GetSourceType * retuns type library table entry's type for library source. @@ -228,30 +651,36 @@ protected: ///< derived classes must implement * Function ReadParts * fetches the s-expressions for each part given in @a aPartNames, into @a aResults, * honoring the array indices respectfully. + * @param aPartNames is a list of part names, one name per list element. + * @param aResults receives the s-expressions */ - virtual void ReadParts( STRINGS* aResults, const STRINGS& aPartNames ) throw( IO_ERROR ) = 0; + virtual void ReadParts( STRING_TOKS* aResults, const STRINGS& aPartNames ) throw( IO_ERROR ) = 0; /** * Function GetCategories * fetches all categories present in the library source into @a aResults */ - virtual void GetCategories( STRINGS* aResults ) throw( IO_ERROR ) = 0; + virtual void GetCategories( STRING_TOKS* aResults ) throw( IO_ERROR ) = 0; /** * Function GetCategoricalPartNames * fetches all the part names for @a aCategory, which was returned by GetCategories(). * - * @param aCategory is a subdividing navigator within the library source, but may default to empty - * which will be taken to mean all categories. + * @param aCategory is a subdividing navigator within the library source, + * but may default to empty which will be taken to mean all categories. + * + * @param aResults is a place to put the fetched result, one category per STRING. */ - virtual void GetCategoricalPartNames( STRINGS* aResults, const STRING& aCategory=StrEmpty ) throw( IO_ERROR ) = 0; + virtual void GetCategoricalPartNames( STRING_TOKS* aResults, + const STRING& aCategory=StrEmpty ) throw( IO_ERROR ) = 0; /** * Function GetRevisions * fetches all revisions for @a aPartName into @a aResults. Revisions are strings * like "rev12", "rev279", and are library source agnostic. These */ - virtual void GetRevisions( STRINGS* aResults, const STRING& aPartName ) throw( IO_ERROR ) = 0; + virtual void GetRevisions( STRING_TOKS* aResults, + const STRING& aPartName ) throw( IO_ERROR ) = 0; /** * Function FindParts @@ -262,11 +691,15 @@ protected: ///< derived classes must implement * the actual library data is remotely located, otherwise it will be too slow * to honor this portion of the API contract. * - * @param aQuery is a string holding a domain specific language expression. One candidate - * here is an s-expression that uses (and ..) and (or ..) operators. For example - * "(and (footprint 0805)(value 33ohm)(category passives))" + * @param aQuery is a string holding a domain specific query language expression. One candidate + * here is an s-expression that uses (and ..) and (or ..) operators and used them as RPN. For example + * "(and (footprint 0805)(value 33ohm)(category passives))". + * The UI can shield the user from this if it wants. + * + * @param aResults is a place to put the fetched part names, one part per STRING. */ - virtual void FindParts( STRINGS* aResults, const STRING& aQuery ) throw( IO_ERROR ) = 0; + virtual void FindParts( STRING_TOKS* aResults, + const STRING& aQuery ) throw( IO_ERROR ) = 0; protected: STRING sourceType; @@ -275,15 +708,86 @@ protected: /** - * Class LIBRARY_SINK - * is an abstract class from which implementation specific LIBRARY_SINKs + * Class DIR_LIB_SOURCE + * implements a LIB_SOURCE in a file system directory. + */ +class DIR_LIB_SOURCE : public LIB_SOURCE +{ + friend class LIBS; ///< LIBS::GetLib() can construct one. + +protected: + + /** + * Constructor DIR_LIB_SOURCE( const STRING& aDirectoryPath ) + * sets up a LIB_SOURCE using aDirectoryPath in a file system. + * @see LIBS::GetLibrary(). + * + * @param aDirectoryPath is a full pathname of a directory which contains + * the library source of part files. Examples might be "C:\kicad_data\mylib" or + * "/home/designer/mylibdir". + */ + DIR_LIB_SOURCE( const STRING& aDirectoryPath ) throws( IO_ERROR ); +}; + + +/** + * Class SVN_LIB_SOURCE + * implements a LIB_SOURCE in a subversion repository. + */ +class SVN_LIB_SOURCE : public LIB_SOURCE +{ + friend class LIBS; ///< constructor the LIB uses these functions. + +protected: + + /** + * Constructor SVN_LIB_SOURCE( const STRING& aSvnURL ) + * sets up a LIB_SOURCE using aSvnURI which points to a subversion + * repository. + * @see LIBS::GetLibrary(). + * + * @param aSvnURL is a full URL of a subversion repo directory. Example might + * be "svn://kicad.org/repos/library/trunk" + */ + SVN_LIB_SOURCE( const STRING& aSvnURL ) throws( IO_ERROR ); +}; + + +/** + * Class SCHEMATIC_LIB_SOURCE + * implements a LIB_SOURCE in by reading a parts list from schematic file + * unrelated to the schematic currently being edited. + */ +class SCHEMATIC_LIB_SOURCE : public LIB_SOURCE +{ + friend class LIBS; ///< constructor the LIB uses these functions. + +protected: + + /** + * Constructor SCHEMATIC_LIB_SOURCE( const STRING& aSchematicFile ) + * sets up a LIB_SOURCE using aSchematicFile which is a full path and filename + * for a schematic not related to the schematic being editing in + * this EESCHEMA session. + * @see LIBS::GetLibrary(). + * + * @param aSchematicFile is a full path and filename. Example: + * "/home/user/kicadproject/design.sch" + */ + SCHEMATIC_LIB_SOURCE( const STRING& aSchematicFile ) throws( IO_ERROR ); +}; + + +/** + * Class LIB_SINK + * is an abstract class from which implementation specific LIB_SINKs * may be derived, one for each kind of library type in the library table that * supports writing. The class name stems from the fact that this interface * only provides WRITE functions. */ -class LIBRARY_SINK +class LIB_SINK { - friend class LIBRARY; ///< only the LIBRARY uses these functions. + friend class LIB; ///< only the LIB uses these functions. protected: ///< derived classes must implement @@ -291,10 +795,11 @@ protected: ///< derived classes must implement * Function WritePart * saves the part to non-volatile storage. @a aPartName may have the revision * portion present. If it is not present, and a overwrite of an existhing - * part is done, then LIBRARY::ReloadPart() must be called on this same part + * part is done, then LIB::ReloadPart() must be called on this same part * and all parts that inherit it must be reparsed. */ - virtual void WritePart( const STRING& aPartName, const STRING& aSExpression ) throw( IO_ERROR ) = 0; + virtual void WritePart( const STRING& aPartName, + const STRING& aSExpression ) throw( IO_ERROR ) = 0; protected: @@ -305,85 +810,87 @@ protected: /** * Class LIBS - * houses a handful of functions that manage all the RAM resident LIBRARYs, and + * houses a handful of functions that manage all the RAM resident LIBs, and * provide for a global part lookup function, GetPart(), which can be the basis - * of cross LIBRARY hyperlink. + * of a cross LIB hyperlink. */ class LIBS { +public: + /** * Function GetPart * finds and loads a PART, and parses it. As long as the part is - * accessible in any LIBRARY_SOURCE, opened or not opened, this function - * will find it and load it into its containing LIBRARY, even if that means - * having to load a new LIBRARY as given in the library table. + * accessible in any LIB_SOURCE, opened or not opened, this function + * will find it and load it into its containing LIB, even if that means + * having to load a new LIB as given in the library table. */ static PART* GetPart( const LPID& aLogicalPartID ) throw( IO_ERROR ); /** - * Function GetLIBRARY + * Function GetLib * is first a lookup function and then if needed, a factory function. * If aLogicalLibraryName has been opened, then return the already opened - * LIBRARY. If not, then instantiate the library and fill the initial + * LIB. If not, then instantiate the library and fill the initial * library PARTs (unparsed) and categories, and add it to LIB::libraries * for future reference. */ - static LIBRARY* GetLibrary( const STRING& aLogicalLibraryName ) throw( IO_ERROR ); + static LIB* GetLib( const STRING& aLogicalLibraryName ) throw( IO_ERROR ); /** - * Function GetOpenedLibraryNames - * returns the logical library names of LIBRARYs that are already opened. + * Function GetOpenedLibNames + * returns the logical library names of LIBs that are already opened. * @see LPID::GetLogicalLibraries() */ - static STRINGS GetOpendedLogicalLibraryNames(); + static STRINGS GetOpendedLogicalLibNames(); /** * Function CloseLibrary - * closes an open library @a aLibrary and removes it from LIBS::libraries. + * closes an open library @a aLibrary and removes it from class LIBS. */ - static void CloseLibrary( LIBRARY* aLibrary ) throw( IO_ERROR ); + static void CloseLibrary( LIB* aLibrary ) throw( IO_ERROR ); private: - /// collection of LIBRARYs, searchable by logical name. - static std::map< STRING, LIBRARY* > libraries; // owns the LIBRARYs. + /// collection of LIBs, searchable by logical name. + static std::map< STRING, LIB* > libraries; // owns the LIBs. }; /** - * Class LIBRARY - * is a cache of parts, and because the LIBRARY_SOURCE is abstracted, there + * Class LIB + * is a cache of parts, and because the LIB_SOURCE is abstracted, there * should be no need to extend from this class in any case except for the * PARTS_LIST. */ -class LIBRARY +class LIB { - friend class LIBS; ///< the LIBRARY factory is LIBS::GetLibrary() + friend class LIBS; ///< the LIB factory is LIBS::GetLibrary() protected: // constructor is not public, called from LIBS only. /** - * Constructor LIBRARY - * is not public and is only called from LIBS::GetLibrary() + * Constructor LIB + * is not public and is only called from LIBS::GetLib() * * @param aLogicalLibrary is the name of a well know logical library, and is * known because it already exists in the library table. * - * @param aLibrarySource is an open LIBRARY_SOURCE whose ownership is - * given over to this LIBRARY. + * @param aSource is an open LIB_SOURCE whose ownership is + * given over to this LIB. * - * @param aLibrarySink is an open LIBRARY_SINK whose ownership is given over - * to this LIBRARY, and it is normally NULL. + * @param aSink is an open LIB_SINK whose ownership is given over + * to this LIB, and it is normally NULL. */ - LIBRARY( const STRING& aLogicalLibrary, LIBRARY_SOURCE* aSource, LIBRARY_SINK* aSink ) : + LIB( const STRING& aLogicalLibrary, LIB_SOURCE* aSource, LIB_SINK* aSink=NULL ) : name( aLogicalLibrary ), source( aSource ), sink( aSink ) { } - ~LIBRARY() + ~LIB() { delete source; delete sink; @@ -394,17 +901,24 @@ public: /** * Function HasSink - * returns true if this library has write/save capability. Most LIBARARYs - * are read only, and all remote ones are. + * returns true if this library has write/save capability. Most LIBs + * are read only. */ - bool HasSave() { return sink != NULL; } + bool HasSink() { return sink != NULL; } + /** + * Function LogicalName + * returns the logical name of this LIB. + */ + STRING LogicalName(); //-------------------------------------- /** * Function GetPart * returns a PART given @a aPartName, such as "passives/R". + * @param aPartName is local to this LIB and does not have the logical + * library name prefixed. */ const PART* GetPart( const STRING& aPartName ) throw( IO_ERROR ); @@ -418,17 +932,19 @@ public: /** * Function GetCategories - * fetches all categories of parts within this LIBRARY into @a aResults. + * returns all categories of parts within this LIB into @a aResults. */ - void GetCategories( STRINGS* aResults ) throw( IO_ERROR ) = 0; + STRINGS GetCategories() throw( IO_ERROR ); /** - * Function GetCategoricalPartName - * fetches the part names for @a aCategory into @a aResults, and at the same time + * Function GetCategoricalPartNames + * returns the part names for @a aCategory, and at the same time * creates cache entries for the very same parts if they do not already exist - * in this LIBRARY cache. + * in this LIB (i.e. cache). */ - void GetCategoricalPartNames( STRINGS* aResults, const STRING& aCategory=StrEmpty ) throw( IO_ERROR ) = 0; + STRINGS GetCategoricalPartNames( const STRING& aCategory=StrEmpty ) throw( IO_ERROR ); + + //-----<.use delegates: source and sink>-------------------------------- @@ -436,24 +952,24 @@ public: * Function WritePart * saves the part to non-volatile storage. @a aPartName may have the revision * portion present. If it is not present, and a overwrite of an existing - * part is done, then all parts that inherit it must be reparsed. + * part is done, then all parts that inherit it must be re-parsed. * This is why most library sources are read only. An exception is the PARTS_LIST, - * not to be confused with a LIBRARY based on a parts list in another schematic. + * not to be confused with a LIB based on a parts list in another schematic. * The PARTS_LIST is in the the schematic being edited and is by definition the * last to inherit, so editing in the current schematic's PARTS_LIST should be harmless. * There can be some self referential issues that mean all the parts in the PARTS_LIST - * have to reparsed. + * have to re-parsed. */ - virtual void WritePart( PART* aPart ) throw( IO_ERROR ) = 0; + virtual void WritePart( PART* aPart ) throw( IO_ERROR ); virtual void SetPartBody( PART* aPart, const STRING& aSExpression ) throw( IO_ERROR ); /** * Function GetRevisions - * returns the revisions of @a aPartName that are present in this LIBRARY. + * returns the revisions of @a aPartName that are present in this LIB. * The returned STRINGS will look like "rev1", "rev2", etc. */ - STRINGS GetRevisions( const STRING& aPartName ) throw( IO_ERROR ) = 0; + STRINGS GetRevisions( const STRING& aPartName ) throw( IO_ERROR ); /** * Function FindParts @@ -465,22 +981,23 @@ public: * to honor this portion of the API contract. * * @param aQuery is a string holding a domain specific language expression. One candidate - * here is an s-expression that uses (and ..) and (or ..) operators. For example + * here is an RPN s-expression that uses (and ..) and (or ..) operators. For example * "(and (footprint 0805)(value 33ohm)(category passives))" */ - STRINGS FindParts( const STRING& aQuery ) throw( IO_ERROR ) = 0 + STRINGS FindParts( const STRING& aQuery ) throw( IO_ERROR ); { // run the query on the cached data first for any PARTS which are fully - // parsed (i.e. cached), then on the LIBRARY_SOURCE to find any that + // parsed (i.e. cached), then on the LIB_SOURCE to find any that // are not fully parsed, then unify the results. } private: - STRING fetched; ///< scratch, used to fetch things, grows to worst case size. + STRING fetch; // scratch, used to fetch things, grows to worst case size. + STRINGS vfetch; // scratch, used to fetch things. - LIBARARY_SOURCE* source; - LIBRARY_SINK* sink; + LIB_SOURCE* source; + LIB_SINK* sink; STRING name; STRING libraryType; @@ -488,9 +1005,108 @@ private: STRINGS categories; - typedef std::map PARTS; + typedef boost::ptr_vector PARTS; PARTS parts; + + std::vector orderByName; }; + +/** + * Class PARTS_LIST + * is a LIB which resides in a SCHEMATIC, and it is a table model for a + * spread sheet both. When columns are added or removed to/from the spreadsheet, + * this is adding or removing fields/properties to/from ALL the contained PARTS. + */ +class PARTS_LIST : public LIB +{ +public: + + /** + * Function GetModel + * returns a spreadsheet table model that allows both reading and writing to + * rows in a spreadsheet. The UI hold the actual screen widgets, but + * the table model is this. + */ + SPREADSHEET_TABLE_MODEL* GetModel(); +}; + + +/** + * Class LIB_TABLE_ROW + * holds a record identifying a LIB in the LIB_TABLE. + */ +class LIB_TABLE_ROW +{ + +protected: + + /** + * Function SetLogicalName + * changes the logical name of this library, useful for an editor. + */ + void SetLogicalName( const STRING& aLogicalName ); + + /** + * Function SetType + * changes the type represented by this record. + */ + void SetType( const STRING& aType ); + + /** + * Function SetFullURI + * changes the full URI for the library, useful from a library table editor. + */ + void SetFullURI( const STRING& aFullURI ); + + /** + * Function SetOptions + * changes the options string for this record, and is useful from + * the library table editor. + */ + void SetOptions( const STRING& aOptions ); + + +public: + + /** + * Function GetLogicalName + * returns the logical name of this library table entry. + */ + const STRING& GetLogicalName(); + + + /** + * Function GetType + * returns the type of LIB represented by this record. + */ + const STRING& GetType(); + + /** + * Function GetFullURI + * returns the full location specifying URI for the LIB. + */ + const STRING& GetFullURI(); + + /** + * Function GetOptions + * returns the options string, which may hold a password or anything else needed to + * instantiate the underlying LIB_SOURCE. + */ + const STRING& GetOptions(); +}; + +/** + * Class LIB_TABLE + * holds LIB_TABLE_ROW records, and can be searched in a very high speed way based on + * logical library name. + */ +class LIB_TABLE +{ +}; + +} // namespace SCH + + // EOF diff --git a/new/drawing.png b/new/drawing.png new file mode 100644 index 0000000000..3f2e0972c4 Binary files /dev/null and b/new/drawing.png differ diff --git a/new/drawing.svg b/new/drawing.svg new file mode 100644 index 0000000000..690689d41d --- /dev/null +++ b/new/drawing.svg @@ -0,0 +1,961 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + schematic + + HTTP_LIB_SOURCE + + + + comp + + + + + + parts_list + + + + + part + + + + + + part + + + + + + part + + + + + + comp + + + + + + comp + + + + + + part + + + + LIBS manager + + + is + + + + is + + + + is + + + inherits + + + + part + + + + + + part + + + + + + part + + + + + inherits + inherits + + inherits + + DIR_LIB_SOURCE + SCHEMATIC_LIB_SOURCE + + + + + + + + part + + + + + + part + + + All sheets are in one schematic object + + + + + part + + + + + + part + + + other schematic + + Internet + + LIB + + part files in a dir + LIB + LIB + + + + part + + + + + + part + + + + PARTS_LIST_LIB_SOURCE + + diff --git a/new/make-html.sh b/new/make-html.sh new file mode 100755 index 0000000000..67f03c4b66 --- /dev/null +++ b/new/make-html.sh @@ -0,0 +1,3 @@ + +# run this from the /new directory +doxygen