Structure for specifying the features of a comment in some text file. More...

#include <textguard.h>

Public Member Functions
	TextGuard (const std::string &left_in, const std::string &right_in=std::string(""), LineSpan spans_in=LineSpan::SINGLE)
	Constructor for text comment records.

	~TextGuard ()=default
	Default destructor.

const std::string &	getLeft () const
	Get the left-hand guard.

const std::string &	getRight () const
	Get the right-hand guard.

int	leftSize () const
	Get the size of the left-hand guard, in terms of the number of characters.

int	rightSize () const
	Get the size of the right-hand guard, in terms of the number of characters.

LineSpan	getSpan () const
	Get the line span of this TextGuard object: is it limited to a single line, or can it span multiple lines?

bool	getTerminationRequirement () const
	Get the (boolean) termination requirement: yes or no, does guarded text need to end with an explicit right-hand guard? (If the TextGuard has no right-hand delimiter then the answer is no, and the TextGuard must also be single-line in its scope.)

Detailed Description

Structure for specifying the features of a comment in some text file.

Constructor & Destructor Documentation

stormm::parse::TextGuard::TextGuard	(	const std::string &	left_in,
		const std::string &	right_in = std::string(""),
		LineSpan	spans_in = LineSpan::SINGLE )

Constructor for text comment records.

Parameters

left_in	Left-hand delimiter
right_in	Right-hand delimiter
spans_in	Line span rules (single or multiple lines)

The documentation for this class was generated from the following files: