zhangyiss/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2025-09-18 02:08:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: add and rewrite comments

Browse Source
This commit is contained in:
ToruNiina
2019-03-18 11:09:12 +09:00
parent 65c2c3c238
commit f40fd12e25
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
toml/region.hpp
View File

@@ -15,7 +15,7 @@ namespace toml
namespace detail namespace detail
{ {
// helper function to avoid std::string(0, 'c') // helper function to avoid std::string(0, 'c') or std::string(iter, iter)
template<typename Iterator> template<typename Iterator>
std::string make_string(Iterator first, Iterator last) std::string make_string(Iterator first, Iterator last)
{ {
@@ -28,9 +28,7 @@ inline std::string make_string(std::size_t len, char c)
return std::string(len, c); return std::string(len, c);
} }
// region in a container, normally in a file content. // region_base is a base class of location and region that are defined below.
// shared_ptr points the resource that the iter points.
// combinators returns this.
// it will be used to generate better error messages. // it will be used to generate better error messages.
struct region_base struct region_base
{ {
@@ -48,16 +46,19 @@ struct region_base
virtual std::string line() const {return std::string("unknown line");} virtual std::string line() const {return std::string("unknown line");}
virtual std::string line_num() const {return std::string("?");} virtual std::string line_num() const {return std::string("?");}
virtual std::size_t before() const noexcept {return 0;} // length of the region
virtual std::size_t size() const noexcept {return 0;} virtual std::size_t size() const noexcept {return 0;}
// number of characters in the line before the region
virtual std::size_t before() const noexcept {return 0;}
// number of characters in the line after the region
virtual std::size_t after() const noexcept {return 0;} virtual std::size_t after() const noexcept {return 0;}
}; };
// location in a container, normally in a file content. // location represents a position in a container, which contains a file content.
// shared_ptr points the resource that the iter points.
// it can be used not only for resource handling, but also error message.
//
// it can be considered as a region that contains only one character. // it can be considered as a region that contains only one character.
//
// it contains pointer to the file content and iterator that points the current
// location.
template<typename Container> template<typename Container>
struct location final : public region_base struct location final : public region_base
{ {
@@ -131,6 +132,10 @@ struct location final : public region_base
const_iterator iter_; const_iterator iter_;
}; };
// region represents a range in a container, which contains a file content.
//
// it contains pointer to the file content and iterator that points the first
// and last location.
template<typename Container> template<typename Container>
struct region final : public region_base struct region final : public region_base
{ {