<h1>Fossil Library API Scratchpad</h1>

See also: [download], [th1ish], [f-tools], docs] (refreshed occasionally from current sources)


This source code repository houses experimentation for a potential library API for the SCM]. The primary goal is to port existing behaviour into a library form (the v1 app is extremely monolithic in nature). While it has been informally dubbed "v2", there are no format-breaking changes planned, and the intention is to provide an alternative interface into fossil repositories, as opposed to a replacement for the core fossil application.


This code currently doesn't do much which would interest non-Fossil hackers. It is intended for those interested in following or participating in the design of libfossil. All current Fossil committers (those who have a signed a license waiver on file with DRH) are welcomed contributors - email me your preferred user name to get access:

<strong>License:</strong> same as Fossil: the "2-Clause BSD" a.k.a. "FreeBSD License" with the same license holder (D. Richard Hipp, author of Fossil).


<h2>Status, TODOs, and Whatnot</h2>

All of this code is an <em>experiment</em>, and it does not represent a commitment by anyone that any of this code wll some day end up living under the umbrella of the larger Fossil SCM project. If all goes well, that's the eventual goal, though. It is alpha quality. What's there works but is subject to change and there is still a great deal of the SCM-specific infrastructure left to port in and refactor to make it usable via library-style interfaces. Anyone looking for a project roadmap/timeline is asked respectfully to look elsewhere - there is no timebox on nor schedule for this project/experiment.

A list of recent notable changes is maintained below. The code changes can be followed via [/timeline | the timeline].

The current public (and documented) API can be found in and occasionally that gets to doxygen].

TODOs, design discussions, etc... you might want to get a before starting through list].

An experimental [th1ish|script engine binding] is being created in parallel with the library.

<h2>"Rules" for Code Contributors</h2>

   *  All code contributors must have a license waiver on file with DRH, as the hope is to eventually release this code as the next generation of Fossil. Non-code contributions are happily accepted from anyone.
   *  When working on bits which themselves write to the repository, e.g. creating checkins, please be exceedingly careful not to corrupt the db :-D.
   *  Please try to conform to the overall coding style (as laid out by Fossil v1).
   *  Don't bother using branches unless you really want to - the trunk has no stability guarantees and is very much in flux, so feel free to work there instead of a branch.

There is nothing holy or sacred about this repo, so feel free to hack at will. Generally the quickest/most complete way to test changes it to add them to the th1ish script bindings (in If you prefer writing C-level tests, please add them to <tt>test.c</tt> in the top-level directory or to a new test app if you like. See <tt>FossilApp.c</tt> for a mini-framework to bootstrap new test apps and [f-tools] for examples which take that approach.


<h2>News</h2>

Notable changes (newest at the top)...
   *  20130819: <em>Minor milestone</em>: we can now losslessly round-trip Event Artifacts to/from fossil. Event crosslinking was implemented.
   *  20130816: <b>Milestone:</b> manifest parsing is more or less complete, covering the whole range of control artifact types. Strict validation is done (including the Z-card hash) to ensure that bogus manifests cannot be read (and the generator does the same at several different levels). "Parsing," in this context means converting a raw Fossil manifest to a higher-level (OO) construct. That construct can then be output to a new manifest which is identical to the old one, providing a 100% loss-less round-trip conversion. (Such round-trips are useful only for testing/proof-of-concept, and are not needed in practice.)
   *  20130815: the past couple days have seen many incremental additions to the manifest machinery. We can now "round-trip" some artifact types, parsing them into a high-level form and re-generating them from that high-level form.
   *  20130812: Started the [f-tools].
   *  20130811: Got "manifest crosslinking" of control artifact (tag changes) ported in.
   *  20130810: <b>Milestone:</b> the library its first tag] today! (The timestamp of the tag was intentionally falsified for testing purposes.)
   *  20130808: Restructured source tree and ported build configuration process to (because that's what Fossil uses). Existing build files (not the sources) still require GNU Make on a Unix platform, though. Many thanks to Steve Bennett (autosetup's author) for his assistance.
   *  20130804: ported in the symbol-to-uuid resolution bits from the main repo. These are what allow apps to use short-form UUIDs and symbolic names like "trunk," instead of having to use 40-byte UUIDs everywhere.
   *  20130803: most of the infrastructure for creating and control artifacts] is in place, but we don't yet write them to the db.
   *  20130801: ported in the delta generation/apply code and added script bindings for them.
   *  20130730: changed internal handling of DBs from 1 connection per db to a single main connection to an in-memory db and attaching the to that. Not yet sure if this is a feature or a bug, but it simplifies the internal tracking of db handles notably.
   *  20130728: it can now search for and open a checkout based on a directory name, analog to how v1 finds an open checkout.
   *  20130727: started work on a [/dir?ci=tip&name=th1ish|th1ish script engine binding] for v2. It is of course a work-in-progress but it is extended in parallel to the core lib because that simplifies testing and helps work the kinks out of the core API.
   *  20130726: when opening a repo db, the library now validates that it is a repo db, and can distinguish between/report various types of errors, e.g. repo schema is out of data or the db is not a fossil repo.
   *  20130725: removed the per-instance allocator configuration - it is now library-wide. This simplifies buffer usage and makes it legal to use them before instantiating a fossil context.