Difference between revisions of "LibBZW"

Revision as of 04:51, 10 June 2008

This page contains the design document for an enhancement or feature. It is a work of collaborative development, and may not represent the final design. If you are not part of the development or design group, please post comments and suggestions on the talk page and not in the middle of the design.

libBZW is a proposed library that will encompass current and future BZW functionality, replacing independant implementations in various applications, including bzfs.

Implementation

libBZW will be implemented as a static library within BZFlag. Applications/builds depending on libBZW should be within the BZFlag tree as well for sanity's sake (i.e. BZFS will depend on libBZW, and is within /bzflag/src).

Features

• BZW file parsing

Functionality

libBZW will initially contain methods and functionality from the following sources:

Just so I can keep track of what files I will need initially, obtained via grep, primitive list.
Need to add summaries of functionality desired to be copied/reproduced/replicated from each file. --Lukstr

• bzflag/
  • src/
    • bzfs/
      • bzfs.cxx -- Read worlds (via stream/blob or filename), retrieve WorldInfo
      • BZWReader.h
      • BZWReader.cxx
      • BZWError.cxx
      • BZWError.h
      • CmdLineOptions.cxx
    • bzflag/
      • World.cxx
  • tools/
    • modeltool/
      • modeltool.cxx -- Creating/writing bzw files
• bzwworkbench/
  • src/
    • model/
      • BZWParser.cpp -- Cleaner parser than bzfs?
      • Model.cpp
  • include/
    • model/
      • BZWParser.h
      • Model.h

API