Copied on 09 Aug 2012.
Fork of ConfigFile by
ConfigFile.h@6:f6ceafabe9f8, 2010-09-15 (annotated)
- Committer:
- shintamainjp
- Date:
- Wed Sep 15 13:49:15 2010 +0000
- Revision:
- 6:f6ceafabe9f8
- Parent:
- 5:56d544b8e5c6
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
shintamainjp | 3:7250e339328c | 1 | /** |
shintamainjp | 3:7250e339328c | 2 | * Configuration file interface class (Version 0.0.1) |
shintamainjp | 3:7250e339328c | 3 | * |
shintamainjp | 3:7250e339328c | 4 | * Copyright (C) 2010 Shinichiro Nakamura (CuBeatSystems) |
shintamainjp | 3:7250e339328c | 5 | * http://shinta.main.jp/ |
shintamainjp | 3:7250e339328c | 6 | */ |
shintamainjp | 0:6b4ba48753b9 | 7 | #include "mbed.h" |
shintamainjp | 0:6b4ba48753b9 | 8 | |
shintamainjp | 0:6b4ba48753b9 | 9 | #ifndef _CONFIG_FILE_H_ |
shintamainjp | 0:6b4ba48753b9 | 10 | #define _CONFIG_FILE_H_ |
shintamainjp | 0:6b4ba48753b9 | 11 | |
shintamainjp | 0:6b4ba48753b9 | 12 | /** |
shintamainjp | 0:6b4ba48753b9 | 13 | * Configuration File class. |
shintamainjp | 0:6b4ba48753b9 | 14 | */ |
shintamainjp | 0:6b4ba48753b9 | 15 | class ConfigFile { |
shintamainjp | 0:6b4ba48753b9 | 16 | public: |
shintamainjp | 0:6b4ba48753b9 | 17 | |
shintamainjp | 0:6b4ba48753b9 | 18 | /** |
shintamainjp | 0:6b4ba48753b9 | 19 | * Create a configuration file class. |
shintamainjp | 0:6b4ba48753b9 | 20 | */ |
shintamainjp | 0:6b4ba48753b9 | 21 | ConfigFile(); |
shintamainjp | 4:940510a29b44 | 22 | |
shintamainjp | 0:6b4ba48753b9 | 23 | /** |
shintamainjp | 0:6b4ba48753b9 | 24 | * Destroy a configuration file class. |
shintamainjp | 0:6b4ba48753b9 | 25 | */ |
shintamainjp | 0:6b4ba48753b9 | 26 | ~ConfigFile(); |
shintamainjp | 4:940510a29b44 | 27 | |
shintamainjp | 0:6b4ba48753b9 | 28 | /** |
shintamainjp | 0:6b4ba48753b9 | 29 | * Get a value for a key. |
shintamainjp | 0:6b4ba48753b9 | 30 | * |
shintamainjp | 0:6b4ba48753b9 | 31 | * @param key A target key name. |
shintamainjp | 1:f02e081afe42 | 32 | * @param value A pointer to a value storage. |
shintamainjp | 1:f02e081afe42 | 33 | * @param siz A size of a value storage. |
shintamainjp | 0:6b4ba48753b9 | 34 | * @return A value or NULL. |
shintamainjp | 0:6b4ba48753b9 | 35 | */ |
shintamainjp | 1:f02e081afe42 | 36 | bool getValue(char *key, char *value, size_t siz); |
shintamainjp | 4:940510a29b44 | 37 | |
shintamainjp | 0:6b4ba48753b9 | 38 | /** |
shintamainjp | 0:6b4ba48753b9 | 39 | * Set a set of a key and value. |
shintamainjp | 0:6b4ba48753b9 | 40 | * |
shintamainjp | 0:6b4ba48753b9 | 41 | * @param key A key. |
shintamainjp | 0:6b4ba48753b9 | 42 | * @param value A value. |
shintamainjp | 0:6b4ba48753b9 | 43 | * |
shintamainjp | 0:6b4ba48753b9 | 44 | * @return True if it succeed. |
shintamainjp | 0:6b4ba48753b9 | 45 | */ |
shintamainjp | 0:6b4ba48753b9 | 46 | bool setValue(char *key, char *value); |
shintamainjp | 4:940510a29b44 | 47 | |
shintamainjp | 0:6b4ba48753b9 | 48 | /** |
shintamainjp | 0:6b4ba48753b9 | 49 | * Remove a config. |
shintamainjp | 0:6b4ba48753b9 | 50 | * |
shintamainjp | 0:6b4ba48753b9 | 51 | * @param key A key. |
shintamainjp | 0:6b4ba48753b9 | 52 | * |
shintamainjp | 0:6b4ba48753b9 | 53 | * @return True if it succeed. |
shintamainjp | 0:6b4ba48753b9 | 54 | */ |
shintamainjp | 0:6b4ba48753b9 | 55 | bool remove(char *key); |
shintamainjp | 4:940510a29b44 | 56 | |
shintamainjp | 0:6b4ba48753b9 | 57 | /** |
shintamainjp | 0:6b4ba48753b9 | 58 | * Remove all config. |
shintamainjp | 0:6b4ba48753b9 | 59 | * |
shintamainjp | 0:6b4ba48753b9 | 60 | * @return True if it succeed. |
shintamainjp | 0:6b4ba48753b9 | 61 | */ |
shintamainjp | 0:6b4ba48753b9 | 62 | bool removeAll(void); |
shintamainjp | 4:940510a29b44 | 63 | |
shintamainjp | 6:f6ceafabe9f8 | 64 | /** |
shintamainjp | 6:f6ceafabe9f8 | 65 | * Get a number of configuration sets. |
shintamainjp | 6:f6ceafabe9f8 | 66 | * |
shintamainjp | 6:f6ceafabe9f8 | 67 | * @return number of configuration sets. |
shintamainjp | 6:f6ceafabe9f8 | 68 | */ |
shintamainjp | 5:56d544b8e5c6 | 69 | int getCount(); |
shintamainjp | 6:f6ceafabe9f8 | 70 | |
shintamainjp | 6:f6ceafabe9f8 | 71 | /** |
shintamainjp | 6:f6ceafabe9f8 | 72 | * Get a key and a value. |
shintamainjp | 6:f6ceafabe9f8 | 73 | * |
shintamainjp | 6:f6ceafabe9f8 | 74 | * @param index Index number of this list. |
shintamainjp | 6:f6ceafabe9f8 | 75 | * @param key A pointer to a buffer for key. |
shintamainjp | 6:f6ceafabe9f8 | 76 | * @param keybufsiz A size of the key buffer. |
shintamainjp | 6:f6ceafabe9f8 | 77 | * @param value A pointer to a buffer for value. |
shintamainjp | 6:f6ceafabe9f8 | 78 | * @param valuebufsiz A size of the value buffer. |
shintamainjp | 6:f6ceafabe9f8 | 79 | * |
shintamainjp | 6:f6ceafabe9f8 | 80 | * @return true if it succeed. |
shintamainjp | 6:f6ceafabe9f8 | 81 | */ |
shintamainjp | 5:56d544b8e5c6 | 82 | bool getKeyAndValue(int index, char *key, size_t keybufsiz, char *value, size_t valuebufsiz); |
shintamainjp | 5:56d544b8e5c6 | 83 | |
shintamainjp | 0:6b4ba48753b9 | 84 | /** |
shintamainjp | 0:6b4ba48753b9 | 85 | * Read from the target file. |
shintamainjp | 0:6b4ba48753b9 | 86 | * |
shintamainjp | 0:6b4ba48753b9 | 87 | * @param file A target file name. |
shintamainjp | 0:6b4ba48753b9 | 88 | */ |
shintamainjp | 0:6b4ba48753b9 | 89 | bool read(char *file); |
shintamainjp | 4:940510a29b44 | 90 | |
shintamainjp | 2:d8febae84a45 | 91 | typedef enum { |
shintamainjp | 2:d8febae84a45 | 92 | UNIX, |
shintamainjp | 2:d8febae84a45 | 93 | MAC, |
shintamainjp | 2:d8febae84a45 | 94 | DOS |
shintamainjp | 2:d8febae84a45 | 95 | } FileFormat; |
shintamainjp | 4:940510a29b44 | 96 | |
shintamainjp | 0:6b4ba48753b9 | 97 | /** |
shintamainjp | 0:6b4ba48753b9 | 98 | * Write from the target file. |
shintamainjp | 0:6b4ba48753b9 | 99 | * |
shintamainjp | 4:940510a29b44 | 100 | * @param file A pointer to a file name. |
shintamainjp | 4:940510a29b44 | 101 | * @param header A pointer to a header. |
shintamainjp | 2:d8febae84a45 | 102 | * @param ff File format. |
shintamainjp | 0:6b4ba48753b9 | 103 | */ |
shintamainjp | 4:940510a29b44 | 104 | bool write(char *file, char *header = NULL, FileFormat ff = UNIX); |
shintamainjp | 4:940510a29b44 | 105 | |
shintamainjp | 0:6b4ba48753b9 | 106 | private: |
shintamainjp | 0:6b4ba48753b9 | 107 | typedef struct { |
shintamainjp | 0:6b4ba48753b9 | 108 | char *key; |
shintamainjp | 0:6b4ba48753b9 | 109 | char *value; |
shintamainjp | 0:6b4ba48753b9 | 110 | } config_t; |
shintamainjp | 0:6b4ba48753b9 | 111 | config_t **configlist; |
shintamainjp | 0:6b4ba48753b9 | 112 | static const int MAXCONFIG = 64; |
shintamainjp | 0:6b4ba48753b9 | 113 | static const int MAXLEN_KEY = 64; |
shintamainjp | 0:6b4ba48753b9 | 114 | static const int MAXLEN_VALUE = 128; |
shintamainjp | 0:6b4ba48753b9 | 115 | static const char SEPARATOR = '='; |
shintamainjp | 0:6b4ba48753b9 | 116 | |
shintamainjp | 0:6b4ba48753b9 | 117 | config_t *search(char *key); |
shintamainjp | 0:6b4ba48753b9 | 118 | bool add(config_t *cfg); |
shintamainjp | 0:6b4ba48753b9 | 119 | }; |
shintamainjp | 0:6b4ba48753b9 | 120 | |
shintamainjp | 0:6b4ba48753b9 | 121 | #endif |