inifile/examples/inifile_comment.cpp at main · abin-z/inifile · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
 *  Sample: comment_features
 *  ------------------------
 *  Demonstrates how to use `ini::inifile` to manage comments:
 *    - Set, add, and clear comments for sections and keys
 *    - Support for single-line and multi-line comments
 *    - Access and inspect comment objects
 *    - Save and load INI files with preserved comments
 *
 *  示例：comment_features
 *  -----------------------
 *  演示如何使用 `ini::inifile` 管理注释：
 *    - 设置、追加、清除 section 与 key 的注释
 *    - 支持单行与多行注释
 *    - 获取与查看 comment 对象内容
 *    - 注释随 INI 文件保存与加载持久化
 */

#include <inifile/inifile.h>

int main()
{
  constexpr char path[] = "comment.ini";
  ini::inifile inif;

  // Basic key-value assignment
  inif["section"]["key"] = "value";
  inif["section"]["flag"] = true;

  inif["database"]["host"] = "localhost";
  inif["database"]["port"] = 3306;
  inif["database"]["username"] = "admin";

  inif["network"]["ip"] = "127.0.0.1";
  inif.set("network", "port", 1024).set_comment("network-port");
  inif["network"]["timeout"].set(30).set_comment("Timeout period, in seconds");

  // Set section comments
  inif["database"].set_comment("comment about database section", '#');
  inif["network"].add_comment("network config"); // equivalent to comment().add(...)

  // Set single-line key comments
  inif["database"]["host"].set_comment("database host");
  inif["database"]["port"].set_comment("database port");
  inif.at("database").at("username").set_comment("database username");

  // Append more comment lines
  inif["section"]["key"].add_comment("Extra comment line1.");
  inif["section"]["key"].comment().add("Extra comment line2.");

  // Set multi-line section and key comments
  inif["section"].set_comment("section-comment line1\nsection-comment line2\nsection-comment line3", '#');

  inif["section"]["key"].comment().add({
    "Main key for the section.",
    "Can be any string value.",
    "Used in test cases."
  });
  inif["section"]["key"].comment().add({"Another one.\nFinal line."});

  // Clear comments
  inif["network"]["ip"].clear_comment();      // clear via shortcut
  inif["network"]["port"].comment().clear();  // clear via comment object

  // Access comment object
  ini::comment &cmt = inif["section"]["key"].comment();  // get reference to comment

  // Read comment content
  const std::vector<std::string> &view = inif["section"]["key"].comment().view();       // view (non-owning)
  std::vector<std::string>     cmt_vtr = inif["section"]["key"].comment().to_vector();  // deep copy

  // Save to file
  inif.save(path);

  // Load from file and print
  ini::inifile loadinif;
  loadinif.load(path);
  std::cout << loadinif.to_string() << '\n';
}