This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

LibBZW: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Lukstr (talk | contribs)
m Made comments proper.
Move to SOC 2008 group
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DesignDocument}}
 
''libBZW is a proposed library that will encompass current and future [[BZW]] functionality, replacing independant implementations in various applications, including bzfs.''
''libBZW is a proposed library that will encompass current and future [[BZW]] functionality, replacing independant implementations in various applications, including bzfs.''
==Implementation==
==Implementation==
Line 10: Line 10:
libBZW will initially contain methods and functionality from the following sources:
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.
  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 replicated from each file. --Lukstr
  Need to add summaries of functionality desired to be copied/reproduced/replicated from each file. --Lukstr
*bzflag/
*bzflag/
**src/
**src/
***bzfs/
***bzfs/
****bzfs.cxx
****'''bzfs.cxx''' -- ''Read worlds (via stream/blob or filename), retrieve WorldInfo''
****BZWReader.h
****'''BZWReader.h'''
****BZWReader.cxx
****'''BZWReader.cxx'''
****BZWError.cxx
****'''BZWError.cxx'''
****BZWError.h
****'''BZWError.h'''
****CmdLineOptions.cxx
****'''CmdLineOptions.cxx'''
***bzflag/
***bzflag/
****World.cxx
****'''World.cxx'''
**tools/
**tools/
***modeltool/
***modeltool/
****modeltool.cxx -- ''Is there anything here desireable? --Lukstr''
****'''modeltool.cxx''' -- ''Creating/writing bzw files''
*bzwworkbench/
**src/
***model/
****'''BZWParser.cpp''' -- ''Cleaner parser than bzfs?''
****'''Model.cpp'''
**include/
***model/
****'''BZWParser.h'''
****'''Model.h'''
 
==API==
 
 
[[Category: Summer Of Code 2008]]

Latest revision as of 08:17, 10 February 2013

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