ecos: host/tools/Utils/common/Properties.h annotate

annotate host/tools/Utils/common/Properties.h @ 2729:74dbf4c3f2e1 after-copyright-change-20090129

Update all copyright banners to reflect FSF ownership; fix and improve licence text.

author	jlarmour
date	Thu, 29 Jan 2009 17:47:46 +0000
parents	6736c52df507
children

rev	line source
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	1 // ####ECOSHOSTGPLCOPYRIGHTBEGIN####
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	2 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	3 // This file is part of the eCos host tools.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	4 // Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	5 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	6 // This program is free software; you can redistribute it and/or modify
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	7 // it under the terms of the GNU General Public License as published by
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	8 // the Free Software Foundation; either version 2 or (at your option) any
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	9 // later version.
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	10 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	11 // This program is distributed in the hope that it will be useful, but
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	12 // WITHOUT ANY WARRANTY; without even the implied warranty of
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	14 // General Public License for more details.
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	15 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	16 // You should have received a copy of the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	17 // along with this program; if not, write to the
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	18 // Free Software Foundation, Inc., 51 Franklin Street,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	19 // Fifth Floor, Boston, MA 02110-1301, USA.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	20 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 82 diff changeset	21 // ####ECOSHOSTGPLCOPYRIGHTEND####
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	22 // Properties.h: interface for the CProperties class.
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	23 //
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	24 //////////////////////////////////////////////////////////////////////
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	25
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	26 #if !defined(AFX_PROPERTIES_H__DA938D29_135A_11D3_A50B_00A0C949ADAC__INCLUDED_)
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	27 #define AFX_PROPERTIES_H__DA938D29_135A_11D3_A50B_00A0C949ADAC__INCLUDED_
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	28
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	29 #if _MSC_VER > 1000
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	30 #pragma once
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	31 #endif // _MSC_VER > 1000
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	32
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	33 #include "eCosStd.h"
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	34 #include "Collections.h"
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	35
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	36 //////////////////////////////////////////////////////////////////////
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	37 // This class manages properties and their serialization.
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	38 // What you do is this:
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	39 // 1. Declare the CProperties object
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	40 // 2. Call one or more "Add" functions to associate variables with names
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	41 // 3. Call one of the "Load" or "Save" functions to load or save the values
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	42 // There are three ways in which the "Load" or "Save" functions operate
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	43 // a. Loading/saving to/from a file [LoadFromFile/SaveToFile]
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	44 // In this case the contents of the file will look like
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	45 // name1=value1
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	46 // name2=value2
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	47 // ...
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	48 // b. Loading/saving to/from a command string [LoadFromCommandString/MakeCommandString]
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	49 // In this case the contents of the string will look like
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	50 // -name1=value1 -name2=value2 ...
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	51 // c. Loading/saving to/from the registry [LoadFromRegistry/SaveToRegistry]
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	52 // In this case the registry will contain a set of values (name1, name2,...) each of whose
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	53 // value data is the corresponding value.
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	54 //////////////////////////////////////////////////////////////////////
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	55
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	56 class CProperties
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	57 {
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	58 public:
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	59 CProperties();
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	60 virtual ~CProperties();
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	61
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	62 // Declare various types of property. The functions associate names with
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	63 // variables, but no values are assigned here. That comes later when a
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	64 // load function (such as LoadFromRegistry) is called.
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	65 void Add (LPCTSTR pszName,int &n);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	66 void Add (LPCTSTR pszName,unsigned int &n);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	67 void Add (LPCTSTR pszName,bool &b);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	68 void Add (LPCTSTR pszName,char &c);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	69 void Add (LPCTSTR pszName,unsigned char &c);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	70 void Add (LPCTSTR pszName,short&s);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	71 void Add (LPCTSTR pszName,unsigned short&s);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	72 void Add (LPCTSTR pszName,float&f);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	73 void Add (LPCTSTR pszName,double&f);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	74 void Add (LPCTSTR pszName,String &s);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	75 void Add (LPCTSTR pszName,void *d,unsigned int nLength);
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	76
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	77 // Load from and save to a command string.
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	78 String MakeCommandString () const; // caller must delete []
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	79 bool LoadFromCommandString (LPCTSTR psz);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	80
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	81 // Load from and save to a given file. The format is name=value, one per line.
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	82 bool LoadFromFile(LPCTSTR pszFileName);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	83 bool SaveToFile (LPCTSTR pszFileName) const;
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	84
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	85 #ifdef _WIN32
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	86 bool LoadFromRegistry (HKEY,LPCTSTR);
6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	87 bool SaveToRegistry(HKEY,LPCTSTR) const;
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	88 static bool CreateKey (LPCTSTR pszKey,HKEY hKey=HKEY_CURRENT_USER);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	89 #endif
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	90
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	91 protected:
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	92 static bool CreatePathToFile(LPCTSTR pszDir);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	93
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	94 class CProperty {
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	95 public:
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	96 enum Typetype {Integer, szString, Bool, Char, Short, Float, Double, Void};
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	97 CProperty(LPCTSTR pszName,Typetype type,void *_pData);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	98 virtual ~CProperty();
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	99 friend class CProperties;
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	100 bool SetValue(int n);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	101 bool SetValue(double n);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	102 bool SetValue(void *d,int nLength);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	103 bool SetValue(LPCTSTR psz);
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	104 const String GetStringValue() const;
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	105 unsigned long GetValue() const;
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	106
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	107 protected:
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	108 String strName;
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	109 Typetype Type;
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	110 void *pData;
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	111 unsigned int nLength; // for Void
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	112 };
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	113 CProperty * Lookup (LPCTSTR pszName);
82 6736c52df507 Merge from eCos master repository on 2000-04-14-13:35:46-BST jlarmour parents: 76 diff changeset	114 std::vector<CProperty> ar; // Holds declared properties
76 435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	115 };
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	116
435cced73e2f eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST jlarmour parents: diff changeset	117 #endif // !defined(AFX_PROPERTIES_H__DA938D29_135A_11D3_A50B_00A0C949ADAC__INCLUDED_)

Mercurial > ecos

annotate host/tools/Utils/common/Properties.h @ 2729:74dbf4c3f2e1 after-copyright-change-20090129