version_record.h

Go to the documentation of this file.

#ifndef VERSION_STRUCTURE_GROUP
#define VERSION_STRUCTURE_GROUP
 
/*****************************************************************************\
*                                                                             *
*  Name   : version & version_record                                          *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1996-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include "string_array.h"
 
#include <basis/astring.h>
#include <basis/contracts.h>
 
namespace structures {
 
 
class version : public virtual basis::packable, public virtual basis::orderable
{
public:
  version();  
 
  version(const structures::string_array &version_info);
 
  version(const basis::astring &formatted_string);
 
  version(int major, int minor, int rev = 0, int build = 0);
 
  version(const version &to_copy);
 
  virtual ~version();
 
  version &operator =(const version &to_copy);
 
  DEFINE_CLASS_NAME("version");
 
  virtual basis::astring text_form() const;
 
  bool equal_to(const equalizable &to_test) const;
 
  bool less_than(const orderable &to_test) const;
 
  int components() const;
 
  basis::astring get_component(int index) const;
 
  void set_component(int index, const basis::astring &to_set);
 
  enum version_places { MAJOR, MINOR, REVISION, BUILD };
 
  enum version_style { DOTS, COMMAS, DETAILED };
 
  basis::astring flex_text_form(version_style style = DOTS, int including = -1) const;
 
  static version from_text(const basis::astring &to_convert);
 
  virtual int packed_size() const;
  virtual void pack(basis::byte_array &target) const;
  virtual bool unpack(basis::byte_array &source);
 
 
  // the following methods mainly help on win32 platforms, where the version
  // components are always simple short integers.  there are only ever four
  // of these.  if one adheres to that same scheme on other platforms, then
  // these functions may be helpful.  otherwise, with the mixed alphanumeric
  // versions one sees on unix, these are not so great.
 
  int v_major() const;
 
  int v_minor() const;
  int v_revision() const;
 
  int v_build() const;
 
  bool compatible(const version &that) const;
 
  bool bogus() const;
 
 
  static void *__global_module_handle();
 
//hmmm: storage here is still missing!
 
private:
  structures::string_array *_components;  
};
 
 
 
class version_record : public virtual basis::root_object
{
public:
  virtual ~version_record();
 
  DEFINE_CLASS_NAME("version_record");
 
  basis::astring text_form() const;
    // returns a view of the fields in this record. 
 
  // these describe a particular file:
  basis::astring description;  // the purpose of this file.
  version file_version;  // the version number for this file.
  basis::astring internal_name;  // the internal name of the file.
  basis::astring original_name;  // name of file before possible renamings.
 
  // these describe the project that the file belongs to:
  basis::astring product_name;  // the product this file belongs to.
  version product_version;  // the version of the product.
 
  // these describe the creators of the file:
  basis::astring company_name;  // name of the company that created the file.
 
  // legal matters:
  basis::astring copyright;  // copyright info for this file.
  basis::astring trademarks;  // trademarks related to the file.
 
  // extra pieces not stored in record (yet).
  basis::astring web_address;  // the location of the company on the web.
};
 
 
} //namespace.
 
#endif