nsf / library

lib

Clone Tools

Stats

Commits this week: 0
Total Committers: 6
Last Commit: 14 Oct
Commits this week: 0

Lines of code count not available

Commit Activity

Commits By Day In Week
52 week commits volume
Commits By Day In Week
Commits by day
Commits By Day In Week
Commits by hour
Commits By Hour In Day
Commit calendar
 

Most active committers (90 days)

loading
loading
  • last updated 4 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Sunday 02 Jan 2011
6:12 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

listing(): Trim result string of pretty printer for trailing newlines to avoid their transformation to multiple line breaks.

Options
    • -2
    • +3
    ./doc-tools.tcl
  2. … 1 more file in changeset.
11:28 am

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- add type attribute to style tag

Options
    • -1
    • +1
    ./pp.tcl
3:14 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- library/lib/doc-tools.tcl: Added a link renderer for Tcl commands, pointing to the tcl.tk online reference; usage: <<tclcmd /cmd/>>. - library/nx/nx.nxd: Fixed glossary references pointing to mixin classes. - glossary.html.tmpl: Made the tmpl more robust against the non-existence of glossary entries. - method.html.tmpl: Made Type and Protection fully conditional - doc-tools.tcl: added a @project.is_validated attribute to reflect the validation status of a given project. this should later turn into a derived property. - langRef.xotcl: added a missing </tt> closing tag, to avoid tt pollution of the remaining document space.

Options
    • -1
    • +2
    ./doc-assets/glossary.html.tmpl
    • -3
    • +5
    ./doc-assets/method.html.tmpl
    • -25
    • +58
    ./doc-tools.tcl
  4. … 3 more files in changeset.
Saturday 01 Jan 2011
8:36 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- documentation work

Options
    • -1
    • +1
    ./doc-assets/package.html.tmpl
    • -1
    • +1
    ./doc-tools.tcl
  3. … 5 more files in changeset.
Friday 31 Dec 2010
6:09 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- update of the migration guide

Options
    • -1
    • +1
    ./doc-tools.tcl
    • -1
    • +1
    ./pp.tcl
  3. … 3 more files in changeset.
Wednesday 29 Dec 2010
6:05 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- minor cleanup

Options
    • -1
    • +0
    ./test.tcl
Thursday 23 Dec 2010
1:47 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- nx::pp: don't prepend newline after <pre>

Options
    • -1
    • +1
    ./pp.tcl
Wednesday 22 Dec 2010
12:00 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- doc-tools.tcl: Integrated the nx pretty printer (nx::pp) to render freestanding code listings. - Minor cleanup

Options
    • -2
    • +5
    ./doc-tools.tcl
Tuesday 21 Dec 2010
3:00 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- generic/gentclAPI.decls: Set the ::nsf::setter parameter as required, otherwise ::nsf::setter crashes upon omitting the parameter/setter name. - library/lib/doc-tools.tcl: Reduced verbosity

Options
    • -1
    • +0
    ./doc-tools.tcl
  2. … 2 more files in changeset.
2:54 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- nsf.nxd: Completed a first draft version of the NSF reference (needs to be revised and improved in further iterations) - doc-tools.tcl: Fixed an issue with closing comment blocks (the last comment line closes with an eof), previously dropped silently by the processor.

Options
    • -2
    • +8
    ./doc-tools.tcl
  2. … 3 more files in changeset.
Monday 20 Dec 2010
11:06 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- library/lib/doc-tools.tcl: added [pinfo append] to collect multiple validation reports per entity - library/lib/doc-tools.tcl / owned_parts(): skip entities which are not structured themselves (namely parameters); otherwise they show up in the lefthand navigation or the autosearch box. also: glossary entries now disappeared from these navigation items (do we need them there?). - library/lib/doc-assets/command.html.tmpl: validation reports need to be fused using [join] - library/lib/doc-assets/command.html.tmpl: fixed subcommand support; adjusted and refined the per-command template, as well as @command validation. - Provided for parameter validation for @command and the extraction of the parametersyntax for commands - nsf.nxd: Added to the NSF documentation, namely completed a first round commands ::nsf::alias throughout ::nsf::log. Also: Refactored some glossary entries to nsf.nxd. - glossary: glossary entries can now be shared between projects; this required to make the back references aware of their project context. - @project: added a depends attribute which can be used to express inter-project dependencies. - An empty @doc string is now reported during validation - processor->process(): Added include/exclude filtering based on namespace patterns

Options
    • -89
    • +99
    ./doc-assets/command.html.tmpl
    • -1
    • +1
    ./doc-assets/entity.html.tmpl
    • -3
    • +6
    ./doc-assets/glossary.html.tmpl
    • -3
    • +3
    ./doc-assets/package.html.tmpl
    • -144
    • +263
    ./doc-tools.tcl
  6. … 3 more files in changeset.
3:12 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- added -noCSSClasses to nx::pp render method

Options
    • -1
    • +1
    ./pp.tcl
2:46 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- better separation of state management and css concerns

Options
    • -7
    • +10
    ./pp.tcl
2:35 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- initial checkin of the nx pretty printer

Options
    • -0
    • +1
    ./pkgIndex.tcl
    • -0
    • +232
    ./pp.tcl
Thursday 16 Dec 2010
3:04 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- removed method "setter" from migration guide

Options
    • -2
    • +2
    ./test.tcl
  2. … 4 more files in changeset.
1:52 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- nx::test: made differences in regression test easier to read

Options
    • -1
    • +1
    ./test.tcl
1:51 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- doctools: changed "-slotclass" to "-class"

Options
    • -28
    • +28
    ./doc-tools.tcl
Wednesday 15 Dec 2010
5:08 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Changed parametersyntax visualisation to show variable/replacable elements in italics. - Rewrote the method template for attribute accessors/mutators - Revised and refactored the resolution helper of member entities along an inheritance path to reflect member overloading - Reduced verbosity

Options
    • -0
    • +4
    ./doc-assets/api.css
    • -47
    • +86
    ./doc-assets/attributemethod.html.tmpl
    • -3
    • +3
    ./doc-assets/class.html.tmpl
    • -2
    • +2
    ./doc-assets/method.html.tmpl
    • -2
    • +2
    ./doc-assets/submethod.html.tmpl
    • -21
    • +32
    ./doc-tools.tcl
  7. … 1 more file in changeset.
12:34 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Adjusted the TODOs - Completed marking internally-called methods and provided a first documentation draft for them. - Fixed the indentation level for code listings - Now using method.html.tmpl to render per-object methods in class.html.tmpl - Fixed return (out parameter) validation

Options
    • -53
    • +17
    ./doc-assets/class.html.tmpl
    • -1
    • +4
    ./doc-assets/method.html.tmpl
    • -1
    • +7
    ./doc-tools.tcl
  4. … 2 more files in changeset.
Tuesday 14 Dec 2010
11:00 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Adjusted for multiplicity types - Added new templates: attributemethod.html.tmpl is responsible for rendering accessor/mutators for attribute slots, object.html.tmpl for objects. - I now render attribute slots both in their object parameter view & a method view. Furthermore, I distinguish between the incremental vs. ordinary interface (as requested). - Fixed div boxing scheme (again) - Adjusted various places (method.html.tmpl, submethod.html.tmpl) to display the status marks (more to come) - Streamlined the method views, introducing Type and Protection sections - Started adopting the /obj/ prefix in parameter listings - Made the @use mechanism working again (under validation). Once tiny bit needs to be fixed: The upward propagation of status messages if @use is in place. - Removed the cause for redundant validation calls by traversing the entity hierarchy only once. - Added nx-specific tracers (to distinguish between ensemble and slot objects, ...) For now, they work fine, but are tangled with non-nx tracing. This needs refactoring. - Added another nx-specific tracer which tackles the issue of the __resolve_method_path helper. While quite cumbersome and coupling nxdoc to many internal design decisions of nx, it turns any change in nx.tcl unnecessary. - Fixed ::nx::doc::handleinfo to deal with objects as methods (the case for intermediate ensemble objects). - Added ::nsf::setter support - Fixed the validation support for submethod structures. - Some cleanup (to be continued)

Options
    • -0
    • +78
    ./doc-assets/attributemethod.html.tmpl
    • -8
    • +20
    ./doc-assets/class.html.tmpl
    • -1
    • +1
    ./doc-assets/command.html.tmpl
    • -22
    • +24
    ./doc-assets/entity.html.tmpl
    • -73
    • +74
    ./doc-assets/method.html.tmpl
    • -0
    • +101
    ./doc-assets/object.html.tmpl
    • -4
    • +6
    ./doc-assets/submethod.html.tmpl
    • -142
    • +276
    ./doc-tools.tcl
  9. … 1 more file in changeset.
Friday 10 Dec 2010
4:19 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- introduced a few forms of multiplicty * 0..1 allow empty value * 0..* list, can be empty (equivalent to 0..n) * 1..* list, cannot be empty (equivalent to 1..n) - deprecate multivalued in parameter specs in favor of multiplicty - deprecate allowempty in parameter specs in favor of multiplicty - adjust regression test

Options
    • -1
    • +1
    ./doc-tools.tcl
  2. … 8 more files in changeset.
3:01 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Fixed some naming confusion around @class-object-method - Completed statusmark support down to the @param level - method parameter definitions are now pre-processed during tracing; see ::nx::doc::paraminfo - Continued the pinfo/pdata-based refactoring

Options
    • -1
    • +2
    ./doc-assets/api.css
    • -21
    • +26
    ./doc-assets/method.html.tmpl
    • -96
    • +331
    ./doc-tools.tcl
  4. … 3 more files in changeset.
Tuesday 07 Dec 2010
1:23 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

Accomplishments: - Completed a first version of the sandboxed (partial) evaluation of Tcl source artifacts (packages, script files, C extensions) based on a dedicated child/slave interp environment: see ::nx::doc::Sandbox; the test suite and the test documentation builts run on it. - Based on this infrastructure, we can now generate a snapshot of a program's structure to be documented (and contrast it to the explicitly documented structure). - Added simplistic css sprites for visualising the doc entity status (extra, missing, mismatch, complete); see also library/lib/doc-assets/status.svg and library/lib/doc-assets/status.png - The entity status is printed optionally along with the print name of an entity - Added switch-like parts to represent properties of doc entities: @deprecated, @stashed, @c-implemented, @syshook. The implementation and use of ::nx::doc::SwitchAttribute should be reviewed after having figured out how to proceed using "switching" objparams. - I provide a multi-property dispatcher as doc-syntactic sugar and for mere convenience: @property

Various:

- Corrected some div-boxing mess in the templates

- Added a filtered helper to process entity collections

- Made the mixin layer infrastructure more symmetric (a revoke operation).

- Added tracers for ::nsf::method and ::nsf::alias (remains to be completed)

- Renamed ::nx::doc to ::nx::processor and turned it into another

mixin layer to trace the doc entity creation in e.g. readin()

- Companion (*.nxd) files: Revised the handling of companion

files. Temporarily moved generic/nsf.nxd in the top-level

directory. We need to find a permanent place as its location is

currently derived from the location of the shared extension. A

candidate is doc/ but this is not linked to the shared extension

location at all.

- processor.readin() now returns a collection of entities created

during its execution.

- Improved robustedness and orthogonality: destroy hooks; the

tag-dispatcher can now handle empty comment lines; when placing NSF

object tracer, we now use the freshly added introspection of an

object system's method aliases.

Options
    • -0
    • +20
    ./doc-assets/api.css
    • -7
    • +5
    ./doc-assets/class.html.tmpl
    • -1
    • +1
    ./doc-assets/entity.html.tmpl
    • -3
    • +4
    ./doc-assets/method.html.tmpl
    • -3
    • +5
    ./doc-assets/package.html.tmpl
    • binary
    ./doc-assets/status.png
    • -0
    • +405
    ./doc-assets/status.svg
    • -331
    • +1007
    ./doc-tools.tcl
  9. … 5 more files in changeset.
Sunday 28 Nov 2010
4:14 am

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- rebuild pkgIndex.tcl more eagerly - added error handler to pkg_mkIndex when called via "make libraries-pkgindex" * just show warning and errors when rebuilding pkgIndex files * stop make in case of errors in pkg_mkIndex

Options
    • -15
    • +37
    ./make.tcl
  2. … 3 more files in changeset.
Friday 15 Oct 2010
3:55 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Corrected the link generation for autocomplete/search entries in case of @use chaining and made them location-independent - Removed an superfluous div-closing tag in class.html.tmpl - Refactored the backend code for the auto-completion search box, separating the concerns of rendering the JS array of hashes and serialising entities into a dict representation. The latter allows to discriminate entity-specific rendering behaviour (together with the mixin layer facility). - Added the entity type (its pretty name) to the search results presented to the doc user. - Removed the unwanted "::"s from @project and @package names.

Options
    • -1
    • +1
    ./doc-assets/ac-js
    • -50
    • +47
    ./doc-assets/class.html.tmpl
    • -1
    • +1
    ./doc-assets/entity.html.tmpl
    • -31
    • +60
    ./doc-tools.tcl
  5. … 2 more files in changeset.
Thursday 14 Oct 2010
8:38 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Switch to print_name() for rendering entity names for the search box - Fixed the @parameter generation in method.html.tmpl - @glossary: Support for referencing glossary entries with certain formatting annotations: @gls (minor letters only), @Gls (title), @glspl (plural), @Glspl (title plural), ... Added explicit acronym rendering (long and short forms): @acrfirst, @acr; fixing an id-generation issue for @glossary entities - Completed the first round of amending nx.nxd with @glossary entries and references. - I got rid of curly braces ("{", "}") as marker symbols ("{{...}}", "{{{ ... }}}") for formatting fragments of comment blocks. They proofed sufficiently hairy due to their heavily loaded meaning for the Tcl parser (the unclosed brace issue in Tcl comment blocks, the list-like processing in our comment block parser, ...). Instead, I introduced <<...>> for link-like elements (anchors, glossary references) and MediaWiki-like '''...''' blockmarkers for code listings. Thanks to Victor Guerra for reviewing and discussing this concrete-syntactic design decision. - Increased the robustness of line-by-line parsing for comment blocks. Within the comment block parser, we operate on comment lines as Tcl lists (lindex, lassign, ...). While convenient from a processing perspective, this risks limiting the degrees of freedom when writing comments (e.g., using tabs and spaces to indent inline, grouping words to form lists of lists, ...). By leveraging "args" argument processing through [apply] for line preprocessing, we balance the two requirements. - Verified that @use works between objects and methods. - Some cleanup in the mixin layer code - Resolve interp-alias chains to entity class objects explicitly - Adjusting the Container/Containable mechanism to apply only to part classes relevant to particular container entities. - Fixing support for package rendering as top-level entities (e.g., in the leftbar menu) - Providing the project object to all entities subject to template processing. - Declaring some forwarders public explicitly (to reflect recent changes in the reach of default call protection)

Options
    • -7
    • +13
    ./doc-assets/glossary.html.tmpl
    • -1
    • +1
    ./doc-assets/leftbar.html.tmpl
    • -2
    • +2
    ./doc-assets/method.html.tmpl
    • -3
    • +3
    ./doc-assets/package.html.tmpl
    • -143
    • +300
    ./doc-tools.tcl
  6. … 2 more files in changeset.
Monday 11 Oct 2010
1:35 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- added handling of unstacked csc entries (removed all DEBUG warnings).

Options
    • -1
    • +1
    ./test.tcl
  2. … 10 more files in changeset.
Tuesday 05 Oct 2010
5:24 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- cleanup of __resolve_method_path - change TclShowStack into NsfShowStack() to avoid possible interference with the Tcl* namespace - made the following function static to avoid pollution of the global link namespace: CompiledColonVarFree(), GetRegObject(), ParamGetType()

Options
    • -0
    • +1
    ./test.tcl
  2. … 4 more files in changeset.
4:43 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Major refactoring based on a minimal Mixin Layer facility to modularise optional features (such as templating, documentation verification etc.) in layers of mixins to be applied to the entire entity hierarchy. - Rewrote the html templating machinery in terms of a mixin layer: NxDocRenderer - Used the new modularisation granularity to add @glossary-specific link rendering (following ideas from http://www.alistapart.com/articles/hattrick/) - Completed glossary support and added acronym handling - Added back references and ref counting for @glossary entries (to be displayed with the glossary lists) - I added the short-cut lists for selected part types of @class entities, namely @class-method and @class-attribute. - Fixed the rendering of methods and attributes for ascending alphabetical order.

Options
    • -1
    • +23
    ./doc-assets/api.css
    • -8
    • +41
    ./doc-assets/class.html.tmpl
    • -1
    • +3
    ./doc-assets/entity.html.tmpl
    • -0
    • +37
    ./doc-assets/glossary.html.tmpl
    • -1
    • +0
    ./doc-assets/leftbar.html.tmpl
    • -137
    • +169
    ./doc-tools.tcl
  7. … 2 more files in changeset.
Wednesday 29 Sep 2010
9:54 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Minor revision of template files (to unify the naming of markup labels) - Removed occurrences of old [:let] - Use href() helper method to generate fragments of per-document ("local") anchor names - Introduced more pretty_name and pretty_plurals for part attributes - Make filename generation aware of the property of being a part or partof entity! - Revised the documentation of [::nsf::current] slightly - Adding setter ([:!let]) and getter ([:!get]) to the templating language, both being aware of @use chains. - Refactored the resolution behaviour for part levels, relative to a given entity, into a helper StructuredEntity->owned_parts(). Based on this helper, the navigation structures can be rendered on common grounds (e.g., drop-down search box, menus in th eleft bar) - Adding the attributes "pretty_name" and "pretty_plural" to part attribute slots (used for rendering section names in the nav menu etc.). - Adding a helper method href() to render the href attribute values of entity anchors (links, menu items, ...) - Unified the rendering of the selection data used by the drop-down box for the various entity_types, again, using the owned_parts() helper - Refactored the generation of navigation menu in the left bar into a proper template: leftbar.html.tmpl - Reflect recent naming changes (e.g., predefined.tcl -> nsf.tcl) - Adding support for documentation inheritance; first, fixed @command support for it - Refactored the upward resolution of partof entities into a central and shared facility (Entity->get_upward_path()) - Adjusting for changes in introspection interface (info.callable() -> info.lookup()) - Adding a first aliasing (@use) mechanism. Remains to be tested properly, though it works sufficiently for the known use cases. - Adding some safety checks to Tag->find() - Refactoring context->parse@tag to use the Tag->find() helper (now shared between tag creation and link resolution) - Tag path normalisation (expanding shortcuts, balanced list check, ...) went into Tag->normalise(). - Changed the [:link ...] mechansism ({{@someTag ...}}) to operate on the new tag notation. Added support for sub-method and sub-command link rendering (looks sufficient for the moment). - Changed the existing *.nxd companions to match these notational modifications.

Options
    • -16
    • +16
    ./doc-assets/class.html.tmpl
    • -9
    • +9
    ./doc-assets/command.html.tmpl
    • -48
    • +2
    ./doc-assets/entity.html.tmpl
    • -0
    • +17
    ./doc-assets/leftbar.html.tmpl
    • -4
    • +4
    ./doc-assets/method.html.tmpl
    • -2
    • +2
    ./doc-assets/submethod.html.tmpl
    • -237
    • +428
    ./doc-tools.tcl
  8. … 4 more files in changeset.