To get started using this library, begin by checking out the code from the <a
href="http://developer.berlios.de/svn/?group_id=7489">BerliOS SVN repository</a>. You may find
- help on using the library at '\ref usage'. If you are interested in SENF, feel free to subscribe
+ help on using the library at '\ref senf_usage'. If you are interested in SENF, feel free to subscribe
to the <a href="http://developer.berlios.de/mail/?group_id=7489">SENF mailing lists</a>. If you
- want to contribute, read the docs and \e please adhere to the \ref conventions.
+ want to contribute, read the docs and \e please adhere to the \ref senf_conventions.
- \see \ref usage\n
+ \see \ref senf_usage\n
<a href="../../Examples/doc/html/index.html">Examples</a>
*/
-/** \page usage Using the SENF framework
+/** \page senf_usage Using the SENF framework
The SENF Framework is a collection of loosely coupled modules. The libraries are heavily object
oriented and template based. For compatibility reasons, the libraries are therefore built
SENFSCons build environment and use SVN to manage the code repository. This is the
configuration, described in this documentation.
- \see \ref build \n
- \ref components \n
- \ref svnsetup \n
- \ref overview
+ \see \ref senf_build \n
+ \ref senf_components \n
+ \ref senf_svnsetup \n
+ \ref senf_overview
- \section Preliminaries
+ \section senf_preliminaries Preliminaries
Before starting the development, make sure to fulfill the following requirements:
which relies on \c epoll)
*/
-/** \page build Building the framework
+/** \page senf_build Building the framework
This procedure will test building the complete framework including the unit tests and the
Sniffer test application. This build is \e not needed to use the framework since every project
After you have successfully built the library tests, you can continue to setup your own project
using SENF.
- \see \ref components \n
- \ref svnsetup
+ \see \ref senf_components \n
+ \ref senf_svnsetup
- \section checkout Getting the code
+ \section senf_checkout Getting the code
To access the code, check out the code from the BerliOS repository. Change to your development
directory and use the following subversion command
http://subversion.tigris.org. A very good introduction and reference to subversion is available
at http://svnbook.red-bean.com.
- \section compile Building
+ \section senf_compile Building
To build the library, execute all unit tests and build the Sniffer test application, use
are just arbitrary examples).
*/
-/** \page components The SENF modules
+/** \page senf_components The SENF modules
The framework is made up of several modular components. When using the library, it is possible
to selectively choose to use only a subset of the implemented modules.
- \see \ref build \n
- \ref svnsetup
+ \see \ref senf_build \n
+ \ref senf_svnsetup
\section libPPI libPPI: Packet Processing Infrastructure
\see <a href="../../senfscons/doc/html/index.html">SENFSCons reference</a>
*/
-/** \page svnsetup Setting up a new project using SENF
+/** \page senf_svnsetup Setting up a new project using SENF
The preferred way to use SENF in a new project is to rely on Subversion and make use of the
SENFSCons build environment. The following sections will describe, how this setup works.
- \see \ref build \n
- \ref components \n
- \ref overview
+ \see \ref senf_build \n
+ \ref senf_components \n
+ \ref senf_overview
\section svnext Setting up the project repository
and the code will be checked out into the corresponding directories.
- \section new_conf Configuring SENFSCons
+ \section senf_new_conf Configuring SENFSCons
To set up the build environment, copy the <tt>senfscons/SConstruct.template</tt> to
<tt>SConstruct</tt> in the project root. The default setup of this file is to build all
<a href="http://subversion.tigris.org">Subversion Homepage</a>
*/
-/** \page overview Introduction to the framework
+/** \page senf_overview Introduction to the framework
The SENF framework is relatively complex and makes use of advanced features of the C++
language. To make the most efficient use of the framework, you should have at least a basic
standard library. It is designed, to integrate well into both libraries and to use the same
concepts and ideas.
- \section startup Getting starting developing with SENF
+ \section senf_startup Getting starting developing with SENF
To introduce the framework and it's general structure, a simple example application is provided
in the SENF repository in the \c Sniffer module. Peruse this example to get a first look at how
The simplest way to get started is: copy the Sniffer application and start to modify it.
\see <a href="../../Examples/doc/html/index.html">Examples</a> \n
- \ref components \n
- \ref svnsetup \n
- \ref build
+ \ref senf_components \n
+ \ref senf_svnsetup \n
+ \ref senf_build
- \section conventions Coding Conventions
+ \section senf_conventions Coding Conventions
Here we have laid down the coding conventions used throughout the SENF framework. Please ad here
to these conventions when changing or adding code. If you use emacs, you can use the C++ IDE for
emacs from http://g0dil.de which greatly simplifies following these conventions.
- \subsection conventions_file_naming File Naming
+ \subsection senf_conventions_file_naming File Naming
Files should be named according to the main class they define. A single header file should
define only one main class. Exceptions to this rule are OK.
an implementation from one of the inline files into one of the non-inline files will change
the type of implementation accordingly.
- \subsection conventions_type_naming Type Naming
+ \subsection senf_conventions_type_naming Type Naming
SENF prefers the use of the CapitalziedLettersToSeparateWords convention for class names. In
this case, class names must start with a capital letter. There are some exceptions to this rule:
name. This can also be used by the editor to highlight type names correctly. Additionally,
this convention is compact and does not add additional or repeated overhead.
- \subsection conventions_impl Implementation
+ \subsection senf_conventions_impl Implementation
Only in very few places, SENF allows the use of inline implementations (not to be confused with
inline functions). An \e implementation is inline, if it is written directly into the class
])
PhonyTarget(env, 'fixlinks', [
- '[ ! -r linklint/errorX.txt -o ! -r linklint/errorAX.txt ] || python doclib/fix-links.py -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
+ 'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
])
env.Clean('all', env.Dir('linklint'))
#!/usr/bin/python
-import sys,os.path,fnmatch, HTMLParser, getopt
+import sys,os.path,fnmatch, HTMLParser, getopt, re
class HTMLFilter(HTMLParser.HTMLParser):
self._out.write(data)
def handle_charref(self,name):
- self.handle_data(name)
+ self.handle_data('&#%s;' % name)
def handle_entityref(self,name):
- self.handle_data(name)
+ self.handle_data('&%s;' % name)
def emit_starttag(self,tag,attrs):
self.handle_data('<%s%s>' % (tag, "".join([' %s="%s"' % attr for attr in attrs])))
for anchor in extractor.anchors():
self._addAnchor(anchor, f)
+TAG_RE = re.compile("<[^>]*>")
+REF_RE = re.compile("&[^;]*;")
+def stripHTML(s):
+ s = TAG_RE.sub("",s)
+ s = s.replace(" "," ").replace("\n"," ")
+ s = REF_RE.sub("?",s)
+ return s.strip()
+
class LinkFixer:
def __init__(self, skipdirs=('.svn',)):
self._files = 0
self._found = 0
self._fixed = 0
+ self._removed = {}
class LinkFilter(HTMLFilter):
self._index = index
self._key = key
self._topdir = topdir
- self._skip_a = False
self._found = 0
self._fixed = 0
+ self._removed = {}
def _s_A(self, attrs):
self._skip_a = False
if self._key in dict(attrs).get('href',''):
self._found += 1
ix = [ i for i, attr in enumerate(attrs) if attr[0] == 'href' ][0]
- target = attrs[ix][1]
- if '#' in target:
- anchor = target.split('#')[1]
- target = self._index[anchor]
- if target:
- target = '%s#%s' % (target, anchor)
+ anchor = attrs[ix][1]
+ if '#' in anchor:
+ anchor = anchor.split('#')[1]
+ a = anchor
+ target = None
+ while not target:
+ target = self._index[a]
+ if target:
+ target = '%s#%s' % (target, a)
+ elif a.startswith('g'):
+ a = a[1:]
+ else:
+ break
else:
- target = self._index[os.path.split(target)[1]]
+ anchor = os.path.split(anchor)[1]
+ target = self._index[anchor]
if target:
self._fixed += 1
attrs[ix] = ('href', os.path.join(self._topdir,target))
else:
- self._skip_a = True
+ self._removed[anchor] = {}
+ self._collectFor = anchor
+ self.startCollect()
return
self.emit_starttag('a',attrs)
def _e_A(self):
- if self._skip_a:
- self._skip_a = False
+ if self.collecting():
+ self._removed[self._collectFor][stripHTML(self.endCollect())] = None
else:
self.emit_endtag('a')
def stats(self):
- return (self._found, self._fixed)
+ return (self._found, self._fixed, self._removed)
def fix(self, path, target):
self._files += 1
file(path,"w"))
filt.feed(data)
filt.close()
- self._found += filt.stats()[0]
- self._fixed += filt.stats()[1]
+ found, fixed, removed = filt.stats()
+ self._found += found
+ self._fixed += fixed
+ for anchor, labels in removed.items():
+ for label in labels.keys():
+ self._removed.setdefault((anchor,label),{})[path] = None
def stats(self):
- return (self._files, self._found, self._fixed)
+ return (self._files, self._found, self._fixed, self._removed)
-
-(opts, args) = getopt.getopt(sys.argv[1:], "s:")
+(opts, args) = getopt.getopt(sys.argv[1:], "vs:")
if len(args) != 2:
sys.stderr.write("""Usage:
fix-links.py [-s skip-dir]... <errrorX.txt> <errorAX.txt>
sys.exit(1)
skipdirs = [ val for opt, val in opts if opt == '-s' ]
+verbose = ( '-v', '' ) in opts
+
+if not os.path.exists(args[0]) and not os.path.exists(args[1]):
+ # No bad links to nothing to do
+ sys.exit(0)
fixer = LinkFixer(skipdirs)
fixer.init()
target = None
-for l in file(args[0]):
- l = l.rstrip()
- if l.startswith('/'):
- target = '#' + os.path.split(l)[1]
- elif l.startswith(' /') and not l.endswith('/'):
- sys.stderr.write("%s\n" % l)
- fixer.fix(l[5:], target)
-
-for l in file(args[1]):
- l = l.rstrip()
- if l.startswith('/'):
- target = l.split('#')[1]
- elif l.startswith(' /') and not l.endswith('/'):
- sys.stderr.write("%s\n" % l)
- fixer.fix(l[5:], target)
-
-files, found, fixed = fixer.stats()
+
+if os.path.exists(args[0]):
+ for l in file(args[0]):
+ l = l.rstrip()
+ if l.startswith('/'):
+ target = '#' + os.path.split(l)[1]
+ elif l.startswith(' /') and not l.endswith('/'):
+ sys.stderr.write("%s\n" % l)
+ fixer.fix(l[5:], target)
+
+if os.path.exists(args[1]):
+ for l in file(args[1]):
+ l = l.rstrip()
+ if l.startswith('/'):
+ target = l.split('#')[1]
+ elif l.startswith(' /') and not l.endswith('/'):
+ sys.stderr.write("%s\n" % l)
+ fixer.fix(l[5:], target)
+
+total, found, fixed, removed = fixer.stats()
+
+if verbose:
+ sys.stderr.write("\nRemoved links:\n")
+ for (anchor, label), files in removed.items():
+ sys.stdout.write("%-36.36s %-48.48s %s\n"
+ % ( anchor,
+ "(%s)" % label[:46],
+ " ".join(files.keys())) )
sys.stderr.write("""
Files processed : %5d
Links processed : %5d
Links fixed : %5d
Links removed : %5d
-""" % (files, found, fixed, found-fixed))
+""" % (total, found, fixed, found-fixed))
projects / senf.git / commitdiff