Shinichiro Nakamura
ConfigFile
Dependents: ConfigFile_TestProgram StarBoardOrangeExpansion1 StarBoardOrangeExpansion2 Drive2ChoroQ ... more
ConfigFile.h@5:56d544b8e5c6, 2010-09-15 (annotated)
- Committer:
- shintamainjp
- Date:
- Wed Sep 15 12:23:15 2010 +0000
- Revision:
- 5:56d544b8e5c6
- Parent:
- 4:940510a29b44
- Child:
- 6:f6ceafabe9f8
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 | 5:56d544b8e5c6 | 64 | int getCount(); |
| shintamainjp | 5:56d544b8e5c6 | 65 | |
| shintamainjp | 5:56d544b8e5c6 | 66 | bool getKeyAndValue(int index, char *key, size_t keybufsiz, char *value, size_t valuebufsiz); |
| shintamainjp | 5:56d544b8e5c6 | 67 | |
| shintamainjp | 0:6b4ba48753b9 | 68 | /** |
| shintamainjp | 0:6b4ba48753b9 | 69 | * Read from the target file. |
| shintamainjp | 0:6b4ba48753b9 | 70 | * |
| shintamainjp | 0:6b4ba48753b9 | 71 | * @param file A target file name. |
| shintamainjp | 0:6b4ba48753b9 | 72 | */ |
| shintamainjp | 0:6b4ba48753b9 | 73 | bool read(char *file); |
| shintamainjp | 4:940510a29b44 | 74 | |
| shintamainjp | 2:d8febae84a45 | 75 | typedef enum { |
| shintamainjp | 2:d8febae84a45 | 76 | UNIX, |
| shintamainjp | 2:d8febae84a45 | 77 | MAC, |
| shintamainjp | 2:d8febae84a45 | 78 | DOS |
| shintamainjp | 2:d8febae84a45 | 79 | } FileFormat; |
| shintamainjp | 4:940510a29b44 | 80 | |
| shintamainjp | 0:6b4ba48753b9 | 81 | /** |
| shintamainjp | 0:6b4ba48753b9 | 82 | * Write from the target file. |
| shintamainjp | 0:6b4ba48753b9 | 83 | * |
| shintamainjp | 4:940510a29b44 | 84 | * @param file A pointer to a file name. |
| shintamainjp | 4:940510a29b44 | 85 | * @param header A pointer to a header. |
| shintamainjp | 2:d8febae84a45 | 86 | * @param ff File format. |
| shintamainjp | 0:6b4ba48753b9 | 87 | */ |
| shintamainjp | 4:940510a29b44 | 88 | bool write(char *file, char *header = NULL, FileFormat ff = UNIX); |
| shintamainjp | 4:940510a29b44 | 89 | |
| shintamainjp | 0:6b4ba48753b9 | 90 | private: |
| shintamainjp | 0:6b4ba48753b9 | 91 | typedef struct { |
| shintamainjp | 0:6b4ba48753b9 | 92 | char *key; |
| shintamainjp | 0:6b4ba48753b9 | 93 | char *value; |
| shintamainjp | 0:6b4ba48753b9 | 94 | } config_t; |
| shintamainjp | 0:6b4ba48753b9 | 95 | config_t **configlist; |
| shintamainjp | 0:6b4ba48753b9 | 96 | static const int MAXCONFIG = 64; |
| shintamainjp | 0:6b4ba48753b9 | 97 | static const int MAXLEN_KEY = 64; |
| shintamainjp | 0:6b4ba48753b9 | 98 | static const int MAXLEN_VALUE = 128; |
| shintamainjp | 0:6b4ba48753b9 | 99 | static const char SEPARATOR = '='; |
| shintamainjp | 0:6b4ba48753b9 | 100 | |
| shintamainjp | 0:6b4ba48753b9 | 101 | config_t *search(char *key); |
| shintamainjp | 0:6b4ba48753b9 | 102 | bool add(config_t *cfg); |
| shintamainjp | 0:6b4ba48753b9 | 103 | }; |
| shintamainjp | 0:6b4ba48753b9 | 104 | |
| shintamainjp | 0:6b4ba48753b9 | 105 | #endif |