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 "istring.h"
#include "object_base.h"
#include "packable.h"


class version : public packable, public virtual object_base
{
public:
  version();  

  version(const string_array &version_info);

  version(const istring &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);

  IMPLEMENT_CLASS_NAME("version");

  virtual istring text_form() const;

  bool operator == (const version &to_test) const;

  bool operator < (const version &to_test) const;

  inline bool operator != (const version &to_test) const
          { return !(*this == to_test); }

  int components() const;

  istring get_component(int index) const;

  void set_component(int index, const istring &to_set);

  enum version_places { MAJOR, MINOR, REVISION, BUILD };

  enum version_style { DOTS, COMMAS, DETAILED };

  istring flex_text_form(version_style style = DOTS, int including = -1) const;

  static version from_text(const istring &to_convert);

  void pack(byte_array &target) const;
  bool unpack(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;

  // end win32 specific methods.

private:
  string_array *_components;  
};



class version_record : public virtual object_base
{
public:
  virtual ~version_record();

  IMPLEMENT_CLASS_NAME("version_record");

  istring text_form() const;
    // returns a view of the fields in this record. 

  // these describe a particular file:
  istring description;  // the purpose of this file.
  version file_version;  // the version number for this file.
  istring internal_name;  // the internal name of the file.
  istring original_name;  // name of file before possible renamings.

  // these describe the project that the file belongs to:
  istring product_name;  // the product this file belongs to.
  version product_version;  // the version of the product.

  // these describe the creators of the file:
  istring company_name;  // name of the company that created the file.

  // legal matters:
  istring copyright;  // copyright info for this file.
  istring trademarks;  // trademarks related to the file.

  // extra pieces not stored in record (yet).
  istring web_address;  // the location of the company on the web.
};

#endif

---