Merge remote-tracking branch 'origin/maint-0.2.2'

# Doxyfile 1.5.1

# Doxyfile 1.5.6

# This file describes the settings to be used by the documentation system

# doxygen (www.doxygen.org) for a project

# 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.

# 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, Finnish, French, German, Greek, Hungarian, 

# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 

# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 

# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.

# Croatian, Czech, Danish, Dutch, 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, Slovak, Slovene, Spanish, Swedish, 

# and Ukrainian.

OUTPUT_LANGUAGE        = English

# This tag can be used to specify the encoding used in the generated output. 

# The encoding is not always determined by the language that is chosen, 

# but also whether or not the output is meant for Windows or non-Windows users. 

# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 

# forces the Windows encoding (this is the default for the Windows binary), 

# whereas setting the tag to NO uses a Unix-style encoding (the default for 

# all platforms other than Windows).

USE_WINDOWS_ENCODING   = NO

# 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). 

# 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 the Qt-style comments (thus requiring an 

# explicit @brief command for a brief description.

# comments will behave just like regular Qt-style comments 

# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

# 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. 

# If set to NO, the detailed description appears after the member 

# documentation.

DETAILS_AT_TOP         = NO

# DETAILS_AT_TOP         = 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 

OPTIMIZE_OUTPUT_FOR_C  = YES

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 

# sources only. Doxygen will then generate output that is more tailored for Java. 

# For instance, namespaces will be presented as packages, qualified scopes 

# will look different, etc.

# 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

# 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 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

# 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 

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   = NO

# 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 

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

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

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 

SORT_BRIEF_DOCS        = 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, 

SHOW_DIRECTORIES       = NO

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.

# This will remove the Files entry from the Quick Index and from the 

# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 

# Namespaces page.  This will remove the Namespaces entry from the Quick Index

# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that 

# doxygen should invoke to get the current version for each file (typically from the 

# version control system). Doxygen will invoke the program by executing (via 

# doxygen should invoke to get the current version for each file (typically from 

# the version control system). Doxygen will invoke the program by executing (via 

# popen()) the command <command> <input-file>, where <command> is the value of 

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 

# provided by doxygen. Whatever the program writes to standard output 

INPUT                  = src/common \

                         src/or

# 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

# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS          = *.c \

                         *.h

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).

# Note: To get rid of all source code in the generated output, make sure also 

# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

SOURCE_BROWSER         = YES

# Setting the INLINE_SOURCES tag to YES will include the body 

# of functions and classes directly in the documentation.

STRIP_CODE_COMMENTS    = YES

# If the REFERENCED_BY_RELATION tag is set to YES (the default) 

# 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 (the default) 

# 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.

# 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 compressed HTML help file (.chm) 

# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 

# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

# If the GENERATE_DOCSET tag is set to YES, additional index files 

# will be generated that can be used as input for Apple's Xcode 3 

# integrated development environment, introduced with OSX 10.5 (Leopard). 

# To create a documentation set, doxygen will generate a Makefile in the 

# HTML output directory. Running make will produce the docset in that 

# directory and running "make install" will install the docset in 

# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 

# it at startup.

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 for Tor"

# 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.torproject.Tor

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 

# documentation will contain sections that can be hidden and shown after the 

# page has loaded. For this to work a browser that supports 

# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 

# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

# If the GENERATE_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 

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.

ENUM_VALUES_PER_LINE   = 4

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be

# generated containing a tree-like index structure (just like the one that 

# 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 FRAME, 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 (for instance Mozilla 1.0+, 

# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 

# probably better off using the HTML help feature.

# probably better off using the HTML help feature. Other possible values 

# for this tag are: HIERARCHIES, which will generate the Groups, Directories,

# and Class Hiererachy pages using a tree view instead of an ordered list;

# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which

# disables this behavior completely. For backwards compatibility with previous

# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE

# respectively.

GENERATE_TREEVIEW      = NO

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

#---------------------------------------------------------------------------

# configuration options related to the LaTeX output

#---------------------------------------------------------------------------

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.

HAVE_DOT               = NO

# 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

# 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 

INCLUDED_BY_GRAPH      = YES

# If the CALL_GRAPH and HAVE_DOT tags 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.

# 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.

# 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

DOTFILE_DIRS           = 

# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 

# (in pixels) of the graphs generated by dot. If a graph becomes larger than 

# this value, doxygen will try to truncate the graph, so that it fits within 

# the specified constraint. Beware that most browsers cannot cope with very 

# large images.

MAX_DOT_GRAPH_WIDTH    = 1024

# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 

# (in pixels) of the graphs generated by dot. If a graph becomes larger than 

# this value, doxygen will try to truncate the graph, so that it fits within 

# the specified constraint. Beware that most browsers cannot cope with very 

# large images.

# 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.

MAX_DOT_GRAPH_HEIGHT   = 1024

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 a graph may be further truncated if the graph's 

# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 

# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 

# the graph is not depth-constrained.

# 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, which results in a white background. 

# 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).

# background. This is enabled by default, which results in a transparent 

# background. 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

  tor_assert(s);

  tor_assert(addr_out);

  /* IP, [], /mask, ports */

  /** Longest possible length for an address, mask, and port-range combination.

   * Includes IP, [], /mask, :, ports */

#define MAX_ADDRESS_LENGTH (TOR_ADDR_BUF_LEN+2+(1+INET_NTOA_BUF_LEN)+12+1)

  if (strlen(s) > MAX_ADDRESS_LENGTH) {

 * Reduce over-specific masks (>128 for ipv6, >32 for ipv4) to 128 or 32.

 *

 * The mask is interpreted relative to <b>addr1</b>, so that if a is

 * ::ffff:1.2.3.4, and b is 3.4.5.6,

 * \::ffff:1.2.3.4, and b is 3.4.5.6,

 * tor_addr_compare_masked(a,b,100,CMP_SEMANTIC) is the same as

 * -tor_addr_compare_masked(b,a,4,CMP_SEMANTIC).

 *

tor_addr_compare_masked(const tor_addr_t *addr1, const tor_addr_t *addr2,

                        maskbits_t mbits, tor_addr_comparison_t how)

{

  /** Helper: Evaluates to -1 if a is less than b, 0 if a equals b, or 1 if a

   * is greater than b.  May evaluate a and b more than once.  */

#define TRISTATE(a,b) (((a)<(b))?-1: (((a)==(b))?0:1))

  sa_family_t family1, family2, v_family1, v_family2;

  return a->family == AF_INET6 ? &a->addr.in6_addr : NULL;

}

/** Given an IPv6 address <b>x</b>, yield it as an array of uint8_t.

 *

 * Requires that <b>x</b> is actually an IPv6 address.

 */

#define tor_addr_to_in6_addr8(x) tor_addr_to_in6(x)->s6_addr

/** Given an IPv6 address <b>x</b>, yield it as an array of uint16_t.

 *

 * Requires that <b>x</b> is actually an IPv6 address.

 */

#define tor_addr_to_in6_addr16(x) S6_ADDR16(*tor_addr_to_in6(x))

/** Given an IPv6 address <b>x</b>, yield it as an array of uint32_t.

 *

 * Requires that <b>x</b> is actually an IPv6 address.

 */

#define tor_addr_to_in6_addr32(x) S6_ADDR32(*tor_addr_to_in6(x))

/** Return an IPv4 address in network order for <b>a</b>, or 0 if

{

  return ntohl(tor_addr_to_ipv4n(a));

}

/* Given an IPv6 address, return its mapped IPv4 address in host order, or

/** Given an IPv6 address, return its mapped IPv4 address in host order, or

 * 0 if <b>a</b> is not an IPv6 address.

 *

 * (Does not check whether the address is really a mapped address */

  return a->family == AF_INET ? (tor_addr_to_ipv4h(a) == u) : 0;

}

#define TOR_ADDR_BUF_LEN 48 /* [ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255]

/** Length of a buffer that you need to allocate to be sure you can encode

 * any tor_addr_t.

 *

 * This allows enough space for

 *   "[ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255]",

 * plus a terminating NUL.

 */

#define TOR_ADDR_BUF_LEN 48

int tor_addr_lookup(const char *name, uint16_t family, tor_addr_t *addr_out);

char *tor_dup_addr(const tor_addr_t *addr) ATTR_MALLOC;

#define tor_addr_from_ipv4h(dest, v4addr)       \

  tor_addr_from_ipv4n((dest), htonl(v4addr))

void tor_addr_from_ipv6_bytes(tor_addr_t *dest, const char *bytes);

/** Set <b>dest</b> to the IPv4 address incoded in <b>in</b>. */

#define tor_addr_from_in(dest, in) \

  tor_addr_from_ipv4n((dest), (in)->s_addr);

void tor_addr_from_in6(tor_addr_t *dest, const struct in6_addr *in6);