2021年7月 – Sasapea's Lab

PC系ではテキスト形式のプロパティ・ファイルに設定情報を書き込んでおくことが一般的であるが組み込み系では保存領域が少なかったりするためテキスト形式はあまり使われない。

だが、ESP8266/ESP32は比較的大きな保存領域があるのとSPIFFSという便利な機能があるのでPC系と同じくテキスト形式のプロパティ・ファイルが使えるぞということで作ってみた。

文字列型クラスはArduinoならStringクラスを使うところだが、PC系にも流用できるようstd::stringクラスを使った実装としている。また、ファイルＩＯ処理は派生クラス側で実装するようにしてみた。ファイル形式は[]でセクション名を指定するINIFILE形式だ。

【概要】

bool load(const char* path) override

1	bool load(const char* path) override

プロパティをpathで指定されたファイルから読み込む。(派生クラスで実装)

bool save(const char* path, const char* header = nullptr) override

1	bool save(const char* path, const char* header = nullptr) override

プロパティをpathで指定されたファイルへ書き込む。(派生クラスで実装)

void clear(void)

1	void clear(void)

プロパティを空にする

std::vector<std::string>& getSectionNames(std::vector<std::string>& names)

1	std::vector<std::string>& getSectionNames(std::vector<std::string>& names)

セクション名を列挙する。

std::vector<std::string>& getPropertyNames(std::vector<std::string>& names, const char* section)

1	std::vector<std::string>& getPropertyNames(std::vector<std::string>& names, const char* section)

指定されたセクション内のプロパティ名を列挙する。

void removeSection(const char* section)

1	void removeSection(const char* section)

指定されたセクションを削除する。

void removeProperty(const char* section, const char* name)

1	void removeProperty(const char* section, const char* name)

指定されたプロパティを削除する。

void setProperty(const char* section, const char* name, const char* value)

1	void setProperty(const char* section, const char* name, const char* value)

文字型プロパティを設定する。

void setPropertyInt(const char* section, const char* name, int value)

1	void setPropertyInt(const char* section, const char* name, int value)

数値型プロパティを設定する。

const char* getProperty(const char* section, const char* name, const char* defval = "")

1	const char* getProperty(const char* section, const char* name, const char* defval = "")

文字型プロパティを取得する。

int getPropertyInt(const char* section, const char* name, int defval = 0)

1	int getPropertyInt(const char* section, const char* name, int defval = 0)

数値型プロパティを取得する。

std::string& toString(std::string &str)

1	std::string& toString(std::string &str)

プロパティ全体を文字列形式で取得する。

std::string& toString(std::string &str, const char* section)

1	std::string& toString(std::string &str, const char* section)

指定されたセクション内のプロパティを文字列形式で取得する。

std::string& toStringWithHeader(std::string &str, const char* header)

1	std::string& toStringWithHeader(std::string &str, const char* header)

プロパティ全体をヘッダー付き文字列形式で取得する。(ファイル書き込み用)

bool parse(const char* buf, size_t len)

1	bool parse(const char* buf, size_t len)

[protected]プロパティデータの解析処理。(派生クラス用)

void finish(void)

1	void finish(void)

[protected]プロパティデータの解析終了処理。(派生クラス用)

【サンプル】

#include "espconf.h"

ESPConf conf;

void setup()
{
  conf.load("esp.conf");
  String value1 = conf.getProperty("section", "name1");
  String value2 = conf.getProperty("section", "name2");
  int value3 = conf.getPropertyInt("section", "name3");
}

void loop()
{
}

#include "espconf.h"

ESPConf conf;

void setup()

{

conf.load("esp.conf");

String value1 = conf.getProperty("section", "name1");

String value2 = conf.getProperty("section", "name2");

int value3 = conf.getPropertyInt("section", "name3");

}

void loop()

{

}

【ライブラリ】

/*
  espconf.h - Configure Library for ESP8266/ESP32

  Copyright (c) 2021 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#ifndef __ESPCONF_H
#define __ESPCONF_H

#include "properties.h"
#if defined(ESP32)
  #include "SPIFFS.h"
#elif defined(ESP8266)
  #include "LittleFS.h"
  #define SPIFFS LittleFS
#endif

class ESPConf : public Properties
{
  public:

    ESPConf(void)
    {
    }

    virtual ~ESPConf(void)
    {
    }

    bool load(const char* path) override
    {
      bool rv = false;
      if (SPIFFS.begin())
      {
        File f = SPIFFS.open(path, "r");
        if (f)
        {
          char buf[256];
          clear(); // *1
          size_t size = f.size();
          rv = true;
          while (rv && size)
          {
            size_t len = size < sizeof(buf) ? size : sizeof(buf);
            if ((size_t)f.read((uint8_t *)buf, len) != len)
              rv = false;
            else if (!parse(buf, len)) // *2
              rv = false;
            size -= len;
          }
          finish(); // *3
          f.close();
        }
        SPIFFS.end();
      }
      return rv;
    }

    bool save(const char* path, const char* header = nullptr) override
    {
      bool rv = false;
      if (SPIFFS.begin())
      {
        File f = SPIFFS.open(path, "w+");
        if (f)
        {
          std::string str;
          toStringWithHeader(str, header);
          rv = (size_t)f.write((const uint8_t*)str.c_str(), str.length()) == str.length();
          f.close();
        }
        SPIFFS.end();
      }
      return rv;
    }
};

#endif

espconf.h - Configure Library for ESP8266/ESP32

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#ifndef __ESPCONF_H

#define __ESPCONF_H

#include "properties.h"

#if defined(ESP32)

#include "SPIFFS.h"

#elif defined(ESP8266)

#include "LittleFS.h"

#define SPIFFS LittleFS

#endif

class ESPConf : public Properties

{

public:

ESPConf(void)

{

}

virtual ~ESPConf(void)

{

}

bool load(const char* path) override

{

bool rv = false;

if (SPIFFS.begin())

{

File f = SPIFFS.open(path, "r");

if (f)

{

char buf[256];

clear(); // *1

size_t size = f.size();

rv = true;

while (rv && size)

{

size_t len = size < sizeof(buf) ? size : sizeof(buf);

if ((size_t)f.read((uint8_t *)buf, len) != len)

rv = false;

else if (!parse(buf, len)) // *2

rv = false;

size -= len;

}

finish(); // *3

f.close();

}

SPIFFS.end();

}

return rv;

}

bool save(const char* path, const char* header = nullptr) override

{

bool rv = false;

if (SPIFFS.begin())

{

File f = SPIFFS.open(path, "w+");

if (f)

{

std::string str;

toStringWithHeader(str, header);

rv = (size_t)f.write((const uint8_t*)str.c_str(), str.length()) == str.length();

f.close();

}

SPIFFS.end();

}

return rv;

}

};

#endif

/*
  properties.h - Properties Library

  Copyright (c) 2021 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#ifndef __PROPERTIES_H
#define __PROPERTIES_H

#include <vector>
#include <string>
#include <string.h>
#include <stdlib.h>

class Properties
{
  private:

    typedef struct
    {
      std::string name;
      std::string value;
    } property_t;

    typedef struct
    {
      std::string name;
      std::vector<property_t> properties;
    } section_t;

    std::vector<section_t> _sections;
    section_t _current;
    std::string _linebuf;

  protected:

    std::string& trim(std::string& str)
    {
      std::string::size_type pos;
      pos = str.find_first_not_of(' ');
      if (pos != std::string::npos)
        str.erase(0, pos);
      pos = str.find_last_not_of(' ');
      if (pos != std::string::npos)
        str.erase(pos + 1);
      return str;
    }

    section_t* getSection(const char* name)
    {
      if (name)
      {
        for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)
        {
          if (strcasecmp(sec->name.c_str(), name) == 0)
            return &*sec;
        }
      }
      return nullptr;
    }

    void setSection(section_t &newSection)
    {
      section_t* sec = getSection(newSection.name.c_str());
      if (!sec)
        _sections.push_back(newSection);
      else
      {
        for (auto prop = newSection.properties.begin(); prop != newSection.properties.end(); ++prop)
          setProperty(*sec, *prop);
      }
    }

    property_t* getProperty(section_t* section, const char* name)
    {
      if (section && name)
      {
        for (auto prop = section->properties.begin(); prop != section->properties.end(); ++prop)
        {
          if (strcasecmp(prop->name.c_str(), name) == 0)
            return &*prop;
        }
      }
      return nullptr;
    }

    void setProperty(section_t &section, property_t &prop)
    {
      trim(prop.name);
      trim(prop.value);
      property_t* exists = getProperty(&section, prop.name.c_str());
      if (exists)
        exists->value = prop.value;
      else
        section.properties.push_back(prop);
    }

    bool parse(const char* buf, size_t len)
    {
      while (len--)
      {
        char c = *buf++;
        if (c >= ' ')
          _linebuf += c;
        else if (c == 0x0A)
        {
          trim(_linebuf);
          if (_linebuf.length())
          {
            c = _linebuf[0];
            if (c == '[')
            {
              if (_linebuf[_linebuf.length() - 1] != ']')
                return false; // format error.
              if (_current.properties.size() || _current.name.length())
                setSection(_current);
              _current.name = _linebuf.substr(1, _linebuf.length() - 2);
              _current.properties.clear();
              trim(_current.name);
            }
            else if ((c != ';') && (c != '#'))
            {
              int sep = _linebuf.find('=');
              if (sep < 0)
                sep = _linebuf.length();
              property_t prop = {_linebuf.substr(0, sep), _linebuf.substr(sep + 1)};
              setProperty(_current, prop);
            }
            _linebuf.clear();
          }
        }
      }
      return true;
    }

    void finish(void)
    {
      if (_current.properties.size() || _current.name.length())
        setSection(_current);
      _current.name.clear();
      _current.properties.clear();
      _linebuf.clear();
    }

  public:

    Properties(void)
    {
    }

    virtual ~Properties(void)
    {
    }

    void clear(void)
    {
      _sections.clear();
      _current.name.clear();
      _current.properties.clear();
      _linebuf.clear();
    }

    std::vector<std::string>& getSectionNames(std::vector<std::string>& names)
    {
      names.clear();
      for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)
        names.push_back(sec->name);
      return names;
    }

    std::vector<std::string>& getPropertyNames(std::vector<std::string>& names, const char* section)
    {
      names.clear();
      section_t* sec = getSection(section);
      if (sec)
      {
        for (auto prop = sec->properties.begin(); prop != sec->properties.end(); ++prop)
          names.push_back(prop->name);
      }
      return names;
    }

    void removeSection(const char* section)
    {
      if (section)
      {
        for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)
        {
          if (strcasecmp(sec->name.c_str(), section) == 0)
          {
            _sections.erase(sec);
            break;
          }
        }
      }
    }

    void removeProperty(const char* section, const char* name)
    {
      if (name)
      {
        section_t* sec = getSection(section);
        if (sec)
        {
          for (auto prop = sec->properties.begin(); prop != sec->properties.end(); ++prop)
          {
            if (strcasecmp(prop->name.c_str(), name) == 0)
            {
              sec->properties.erase(prop);
              break;
            }
          }
        }
      }
    }

    void setProperty(const char* section, const char* name, const char* value)
    {
      if (section && name && value)
      {
        section_t newsec = {section, {{name, value}}};
        setSection(newsec);
      }
    }

    void setPropertyInt(const char* section, const char* name, int value)
    {
      if (section && name)
      {
        char buf[16];
        snprintf(buf, sizeof(buf), "%d", value);
        section_t newsec = {section, {{name, buf}}};
        setSection(newsec);
      }
    }

    const char* getProperty(const char* section, const char* name, const char* defval = "")
    {
      property_t* prop = getProperty(getSection(section), name);
      return prop ? prop->value.c_str() : defval;
    }

    int getPropertyInt(const char* section, const char* name, int defval = 0)
    {
      const char* value = getProperty(section, name);
      return *value ? atoi(value) : defval;
    }

    std::string& toString(std::string &str)
    {
      std::vector<std::string> names;
      std::string props;
      str.clear();
      getSectionNames(names);
      for (auto name = names.begin(); name != names.end(); ++name)
        str.append("[").append(*name).append("]\n").append(toString(props, name->c_str()));
      return str;
    }

    std::string& toString(std::string &str, const char* section)
    {
      if (section == nullptr)
        toString(str);
      else
      {
        std::vector<std::string> names;
        str.clear();
        getPropertyNames(names, section);
        for (auto name = names.begin(); name != names.end(); ++name)
         str.append(*name).append("=").append(getProperty(section, name->c_str())).append("\n");
      }
      return str;
    }

    std::string& toStringWithHeader(std::string &str, const char* header)
    {
      str.clear();
      if (header && *header)
      {
        const char* p;
        const char* q;
        p = q = header;
        do
        {
          if ((*q == 0) || (*q == 0x0A))
          {
            str.append("# ").append(p, (int)q - (int)p).append("\n");
            p = q + 1;
          }
        }
        while (*q++);
      }
      std::string props;
      return str.append(toString(props));
    }

    virtual bool load(const char* path) = 0;
    virtual bool save(const char* path, const char* header = nullptr) = 0;
};

#endif

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

properties.h - Properties Library

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#ifndef __PROPERTIES_H

#define __PROPERTIES_H

#include <vector>

#include <string>

#include <string.h>

#include <stdlib.h>

class Properties

{

private:

typedef struct

{

std::string name;

std::string value;

} property_t;

typedef struct

{

std::string name;

std::vector<property_t> properties;

} section_t;

std::vector<section_t> _sections;

section_t _current;

std::string _linebuf;

protected:

std::string& trim(std::string& str)

{

std::string::size_type pos;

pos = str.find_first_not_of(' ');

if (pos != std::string::npos)

str.erase(0, pos);

pos = str.find_last_not_of(' ');

if (pos != std::string::npos)

str.erase(pos + 1);

return str;

}

section_t* getSection(const char* name)

{

if (name)

{

for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)

{

if (strcasecmp(sec->name.c_str(), name) == 0)

return &*sec;

}

return nullptr;

}

void setSection(section_t &newSection)

{

section_t* sec = getSection(newSection.name.c_str());

if (!sec)

_sections.push_back(newSection);

else

{

for (auto prop = newSection.properties.begin(); prop != newSection.properties.end(); ++prop)

setProperty(*sec, *prop);

}

property_t* getProperty(section_t* section, const char* name)

{

if (section && name)

{

for (auto prop = section->properties.begin(); prop != section->properties.end(); ++prop)

{

if (strcasecmp(prop->name.c_str(), name) == 0)

return &*prop;

}

return nullptr;

}

void setProperty(section_t &section, property_t &prop)

{

trim(prop.name);

trim(prop.value);

property_t* exists = getProperty(&section, prop.name.c_str());

if (exists)

exists->value = prop.value;

else

section.properties.push_back(prop);

}

bool parse(const char* buf, size_t len)

{

while (len--)

{

char c = *buf++;

if (c >= ' ')

_linebuf += c;

else if (c == 0x0A)

{

trim(_linebuf);

if (_linebuf.length())

{

c = _linebuf[0];

if (c == '[')

{

if (_linebuf[_linebuf.length() - 1] != ']')

return false; // format error.

if (_current.properties.size() || _current.name.length())

setSection(_current);

_current.name = _linebuf.substr(1, _linebuf.length() - 2);

_current.properties.clear();

trim(_current.name);

}

else if ((c != ';') && (c != '#'))

{

int sep = _linebuf.find('=');

if (sep < 0)

sep = _linebuf.length();

property_t prop = {_linebuf.substr(0, sep), _linebuf.substr(sep + 1)};

setProperty(_current, prop);

}

_linebuf.clear();

}

return true;

}

void finish(void)

{

if (_current.properties.size() || _current.name.length())

setSection(_current);

_current.name.clear();

_current.properties.clear();

_linebuf.clear();

}

public:

Properties(void)

{

}

virtual ~Properties(void)

{

}

void clear(void)

{

_sections.clear();

_current.name.clear();

_current.properties.clear();

_linebuf.clear();

}

std::vector<std::string>& getSectionNames(std::vector<std::string>& names)

{

names.clear();

for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)

names.push_back(sec->name);

return names;

}

std::vector<std::string>& getPropertyNames(std::vector<std::string>& names, const char* section)

{

names.clear();

section_t* sec = getSection(section);

if (sec)

{

for (auto prop = sec->properties.begin(); prop != sec->properties.end(); ++prop)

names.push_back(prop->name);

}

return names;

}

void removeSection(const char* section)

{

if (section)

{

for (auto sec = _sections.begin(); sec != _sections.end(); ++sec)

{

if (strcasecmp(sec->name.c_str(), section) == 0)

{

_sections.erase(sec);

break;

}

void removeProperty(const char* section, const char* name)

{

if (name)

{

section_t* sec = getSection(section);

if (sec)

{

for (auto prop = sec->properties.begin(); prop != sec->properties.end(); ++prop)

{

if (strcasecmp(prop->name.c_str(), name) == 0)

{

sec->properties.erase(prop);

break;

}

void setProperty(const char* section, const char* name, const char* value)

{

if (section && name && value)

{

section_t newsec = {section, {{name, value}}};

setSection(newsec);

}

void setPropertyInt(const char* section, const char* name, int value)

{

if (section && name)

{

char buf[16];

snprintf(buf, sizeof(buf), "%d", value);

section_t newsec = {section, {{name, buf}}};

setSection(newsec);

}

const char* getProperty(const char* section, const char* name, const char* defval = "")

{

property_t* prop = getProperty(getSection(section), name);

return prop ? prop->value.c_str() : defval;

}

int getPropertyInt(const char* section, const char* name, int defval = 0)

{

const char* value = getProperty(section, name);

return *value ? atoi(value) : defval;

}

std::string& toString(std::string &str)

{

std::vector<std::string> names;

std::string props;

str.clear();

getSectionNames(names);

for (auto name = names.begin(); name != names.end(); ++name)

str.append("[").append(*name).append("]\n").append(toString(props, name->c_str()));

return str;

}

std::string& toString(std::string &str, const char* section)

{

if (section == nullptr)

toString(str);

else

{

std::vector<std::string> names;

str.clear();

getPropertyNames(names, section);

for (auto name = names.begin(); name != names.end(); ++name)

str.append(*name).append("=").append(getProperty(section, name->c_str())).append("\n");

}

return str;

}

std::string& toStringWithHeader(std::string &str, const char* header)

{

str.clear();

if (header && *header)

{

const char* p;

const char* q;

p = q = header;

{

if ((*q == 0) || (*q == 0x0A))

{

str.append("# ").append(p, (int)q - (int)p).append("\n");

p = q + 1;

}

while (*q++);

}

std::string props;

return str.append(toString(props));

}

virtual bool load(const char* path) = 0;

virtual bool save(const char* path, const char* header = nullptr) = 0;

};

#endif

月: 2021年7月

ESP8266/ESP32用のプロパティ・ライブラリを作ってみた。