dunedaq::oks Namespace Reference

Namespaces
namespace	oks
namespace	python
namespace	xml

Classes
class	AddRcrError
class	AttributeConversionFailed
class	AttributeRangeError
class	AttributeReadError
class	AuthenticationFailure
	Failed to authenticate user. More...
class	bad_query_syntax
class	BadFileData
class	BadReqExp
struct	BindWarning
class	CannotAddClass
	Failed add new class. More...
class	CanNotBackupFile
	Failed backup file. More...
class	CanNotCreateFile
	Cannot create file. More...
class	CanNotCreateRepositoryDir
	Cannot create file. More...
class	CannotDestroyClass
class	CannotFindSuperClass
class	CanNotOpenFile
	Cannot open file. More...
class	CannotRegisterClass
class	CannotResolvePath
	Failed resolve path. More...
class	CanNotSetActiveFile
	Failed to set active file. More...
class	CanNotSetFile
	Failed move item to file. More...
class	CanNotWriteToFile
	Failed write to file. More...
struct	CommandOutput
class	Comment
	The comment about file modification. A comment can be added when user saves file using OKS tools. More...
class	Date
class	EndOfXmlStream
struct	equal_class_ptr
struct	equal_file_ptr
struct	equal_obj_ptr
struct	equal_str
class	exception
class	FailedAddComment
	Cannot add comment. Such exception is thrown when OKS cannot add new comment. More...
class	FailedAddInclude
	Cannot add include file. Such exception is thrown when OKS cannot add include file. More...
class	FailedChangeComment
	Cannot change comment. Such exception is thrown when OKS cannot change comment. More...
class	FailedCreateObject
class	FailedDestoyObject
class	FailedLoadFile
	Cannot load file. More...
class	FailedRead
class	FailedReadObject
class	FailedReloadFile
	Cannot re-load files. More...
class	FailedRemoveComment
	Cannot remove comment. Such exception is thrown when OKS cannot remove comment. More...
class	FailedRemoveInclude
	Cannot remove include file. Such exception is thrown when OKS cannot remove include file. More...
class	FailedRenameInclude
	Cannot rename include file. Such exception is thrown when OKS cannot rename include file. More...
class	FailedRenameObject
class	FailedSave
class	FailedSaveObject
class	FileChangeError
class	FileCompareError
class	FileLockError
	Cannot add include file. Such exception is thrown when OKS cannot add include file. More...
class	GitFoldersHolder
struct	hash_class_ptr
struct	hash_file_ptr
struct	hash_obj_ptr
struct	hash_str
struct	LoadErrors
class	ObjectBindError
class	ObjectGetError
class	ObjectInitError
class	ObjectOperationFailed
class	ObjectSetError
class	Oks
	Class contains common OKS classes and methods. More...
struct	OksAliasTable
	The struct OksAliasTable is used to support aliases. More...
class	OksAndExpression
	OKS query logical AND expression class. More...
class	OksAttribute
	OKS attribute class. More...
class	OksClass
	The OKS class. More...
class	OksComparator
	OKS query expression comparator class. More...
struct	OksData
	Struct OKS data. More...
struct	OksDataInfo
	Struct OKS data information. More...
class	OksFile
	Provides interface to the OKS XML schema and data files. More...
class	OksFunctionProfiler
class	OksIndex
class	OksJob
class	OksKernel
	Provides interface to the OKS kernel. More...
class	OksListBaseQueryExpression
	Abstract class describing list of OKS query expressions. More...
struct	OksLoadObjectsJob
class	OksMethod
	OKS method class. More...
class	OksMethodImplementation
	OKS method implementation class. More...
struct	OksNameTable
	The struct OksNameTable is used to generate unique strings. More...
class	OksNotExpression
	OKS query logical NOT expression class. More...
class	OksObject
	OksObject describes instance of OksClass. More...
class	OksObjectSortBy
class	OksOrExpression
	OKS query logical OR expression class. More...
class	OksPipeline
class	OksProfiler
class	OksQuery
	OKS query class. More...
class	OksQueryExpression
	OKS query expression class. More...
class	OksRange
	OKS range class. More...
struct	OksRCR
	The struct OksRCR describes Reverse Composite Relationship (i.e. back reference from child to composite parent). More...
class	OksRelationship
class	OksRelationshipExpression
	OKS query relationship expression class. More...
struct	OksRepositoryVersion
class	OksString
	Class OKS string. More...
struct	OksXmlAttribute
class	OksXmlInputStream
class	OksXmlOutputStream
struct	OksXmlRelValue
struct	OksXmlToken
struct	OksXmlTokenPool
struct	OksXmlValue
class	QueryFailed
class	QueryPath
class	QueryPathExpression
struct	ReadFileParams
struct	RefData
struct	ReloadObjects
struct	ReposDirs
class	RepositoryOperationFailed
	Cannot commit, checkout or release files. More...
class	SetOperationFailed
class	Time

Typedefs
typedef std::unordered_set< const OksClass *, oks::hash_class_ptr, oks::equal_class_ptr >	ClassSet

Enumerations
enum	__LogSeverity__ { Error = 0 , Warning , Log , Debug }

Functions
bool	cmp_str1 (const char *s1, const char s2[2])
bool	cmp_str2 (const char *s1, const char s2[3])
bool	cmp_str2n (const char *s1, const char s2[2])
bool	cmp_str3 (const char *s1, const char s2[4])
bool	cmp_str3n (const char *s1, const char s2[3])
bool	cmp_str4 (const char *s1, const char s2[5])
bool	cmp_str4n (const char *s1, const char s2[4])
bool	cmp_str5 (const char *s1, const char s2[6])
bool	cmp_str5n (const char *s1, const char s2[5])
bool	cmp_str6 (const char *s1, const char s2[7])
bool	cmp_str6n (const char *s1, const char s2[6])
bool	cmp_str7 (const char *s1, const char s2[8])
bool	cmp_str7n (const char *s1, const char s2[8])
bool	cmp_str8 (const char *s1, const char s2[9])
bool	cmp_str8n (const char *s1, const char s2[9])
bool	cmp_str9 (const char *s1, const char s2[10])
bool	cmp_str10 (const char *s1, const char s2[11])
bool	cmp_str11 (const char *s1, const char s2[12])
bool	cmp_str12 (const char *s1, const char s2[13])
bool	cmp_str13 (const char *s1, const char s2[14])
bool	cmp_str14 (const char *s1, const char s2[14])
bool	cmp_str15 (const char *s1, const char s2[16])
bool	cmp_str16 (const char *s1, const char s2[17])
const std::string	strerror (int error)
	Convert C error number to string.
std::ostream &	operator<< (std::ostream &s, const oks::exception &ex)
void	throw_validate_not_empty (const char *name)
void	validate_not_empty (const std::string &value, const char *name)
std::ostream &	operator<< (std::ostream &, const OksFile &)
std::ostream &	operator<< (std::ostream &, const oks::Comment &)
double	get_time_interval (const timeval *t1, const timeval *t2)
std::ostream &	log_timestamp (__LogSeverity__ severity=Log)
bool	operator== (const OksString &s1, const OksString &s2)
	Implementation of OksString logical equality operator.
bool	operator== (const OksString &s1, const std::string &s2)
	Implementation of OksString logical equality operator.
bool	operator== (const OksString &s1, const char *s2)
	Implementation of OksString logical equality operator.
bool	operator< (const OksString &s1, const OksString &s2)
	Implementation of OksString logical less operator.
std::ostream &	operator<< (std::ostream &s, const OksString &str)
	Implementation of OksString out stream operator.
std::ostream &	operator<< (std::ostream &, const oks::QueryPathExpression &)
std::ostream &	operator<< (std::ostream &, const oks::QueryPath &)
void	validate_init2range (const OksAttribute *a)
std::ostream &	operator<< (std::ostream &s, const OksAttribute &a)
bool	is_star (const std::string &s)
std::ostream &	operator<< (std::ostream &s, const OksClass &c)
static void	check_and_report_empty_parameter (const char *fname, bool b1, bool b2)
static void	check_and_report_found_items (const char *fname, const char *item_type, const std::string &item1_name, const std::string &item2_name, const std::string &class_name, bool b1, bool b2)
static std::string	add_super_class_error (const std::string &c1, const std::string &c2)
static std::string	remove_super_class_error (const std::string &c1, const std::string &c2)
void	add_if_not_found (OksClass::FList &clist, OksClass *c)
const char *	bool2value_type (bool v)
bool	are_types_different (const OksAttribute *a1, const OksAttribute *a2)
const char *	card2string (OksRelationship::CardinalityConstraint cc)
static bool	is_not_info (const std::string &line)
	ERS_DECLARE_ISSUE (kernel, SetGroupIdFailed, "cannot set group ID "<< id<< " for the file \'"<< file<< "\': chown() failed with code "<< code<< " , reason = \'"<< why<< '\'',((long) id)((const char *) file)((int) code)((std::string) why)) ERS_DECLARE_ISSUE(kernel
Found unresolved	reference (s)
static long	get_file_length (std::ifstream &f)
std::string	make_fname (const char *f, size_t f_len, const std::string &file, bool *p, const OksFile *const *fh)
std::ostream &	operator<< (std::ostream &s, OksKernel &k)
static void	test_file_existence (const std::string &file_name, bool silence, const std::string &fname, const char *msg)
std::string	mk_name_and_test (const std::string &name, const char *test, size_t test_len)
static void	create_updated_lists (const OksFile::Map &files, std::list< OksFile * > **ufs, std::list< OksFile * > **rfs, OksFile::FileStatus wu, OksFile::FileStatus wr)
static bool	_find_file (const OksFile::Map &files, const OksFile *f)
static bool	check_relevant (const std::set< std::string > &loaded_files, const OksRepositoryVersion &ver)
static std::string	replace_datetime_spaces (const std::string &in)
std::ostream &	operator<< (std::ostream &s, const OksMethodImplementation &i)
std::ostream &	operator<< (std::ostream &s, const OksMethod &m)
static void	__throw_unknown_type (const oks::ReadFileParams &params, const char *atype)
std::ostream &	operator<< (std::ostream &s, const OksObject *o)
std::ostream &	operator<< (std::ostream &s, const OksObject &o)
static bool	trim_dangling (OksData &d, const OksKernel &kernel)
static bool	cmp_data (OksData *d, OksData *d2)
static void	test_dangling_references (const OksObject *obj, const OksData &d, const OksRelationship &r, std::string &result)
static void	_references (const OksObject *obj, unsigned long recursion_depth, RefData &data)
static void	insert2refs (const OksObject *o, unsigned long recursion_depth, RefData &data)
boost::posix_time::ptime	str2time (const char *value, size_t len, const char *file_name=nullptr)
boost::gregorian::date	str2date (const char *value, size_t len)
std::ostream &	operator<< (std::ostream &, const Date &)
std::ostream &	operator<< (std::ostream &, const Time &)
static void	printTableSeparator (std::ostream &s, unsigned char c)
static void	printTableLine (std::ostream &s, unsigned char c)
std::ostream &	operator<< (std::ostream &s, const OksProfiler &t)
void	erase_empty_chars (std::string &s)
std::ostream &	operator<< (std::ostream &s, const OksQueryExpression &qe)
std::ostream &	operator<< (std::ostream &s, const OksQuery &gqe)
std::ostream &	operator<< (std::ostream &s, const OksRelationship &r)
static std::string	report_unexpected (const char *what, const char expected, const char read)
static void	__throw_runtime_error_unexpected_symbol (const char expected, const char read)
static void	__throw_bad_file_data_unexpected_symbol (const char *what, const char expected, const char read, unsigned long l, unsigned long p)
bool	__is_comment (const char *s)

Variables
const char	_empty_str [] = "empty"
static std::mutex	s_get_cwd_mutex
static GitFoldersHolder	s_git_folders
	BindError
static const char *	OksProfilerFunctionsStr []

Typedef Documentation

ClassSet

typedef std::unordered_set<const OksClass*, oks::hash_class_ptr, oks::equal_class_ptr> dunedaq::oks::ClassSet

Definition at line 1129 of file object.hpp.

Enumeration Type Documentation

__LogSeverity__

enum dunedaq::oks::__LogSeverity__

Enumerator
Error
Warning
Log
Debug

Definition at line 416 of file kernel.hpp.

{
  Error = 0,
  Warning,
  Log,
  Debug
};

Function Documentation

__is_comment()

bool dunedaq::oks::__is_comment ( const char * s )

inline

Definition at line 332 of file xml.cpp.

{
  return oks::cmp_str4n(s, "<!--");
}

__throw_bad_file_data_unexpected_symbol()

void dunedaq::oks::__throw_bad_file_data_unexpected_symbol ( const char * what, const char expected, const char read, unsigned long l, unsigned long p )

static

Definition at line 110 of file xml.cpp.

{
  throw oks::BadFileData(report_unexpected(what, expected, read), l, p);
}

__throw_runtime_error_unexpected_symbol()

void dunedaq::oks::__throw_runtime_error_unexpected_symbol ( const char expected, const char read )

static

Definition at line 104 of file xml.cpp.

{
  throw std::runtime_error(report_unexpected(0, expected, read));
}

__throw_unknown_type()

void dunedaq::oks::__throw_unknown_type ( const oks::ReadFileParams & params, const char * atype )

static

Definition at line 522 of file object.cpp.

{
  std::ostringstream s;
  s << "Unknown attribute type \"" << atype << '\"';
  throw oks::BadFileData(s.str(), params.s.get_line_no(), params.s.get_line_pos());
}

_find_file()

bool dunedaq::oks::_find_file ( const OksFile::Map & files, const OksFile * f )

static

Definition at line 2954 of file kernel.cpp.

{
  for (OksFile::Map::const_iterator i = files.begin(); i != files.end(); ++i) {
    if (i->second == f)
      return true;
  }
  return false;
}

_references()

void dunedaq::oks::_references ( const OksObject * obj, unsigned long recursion_depth, RefData & data )

static

Definition at line 3012 of file object.cpp.

{
  if (recursion_depth == 0)
    return;
 
  size_t l1 = obj->GetClass()->number_of_all_attributes();
  size_t l2 = l1 + obj->GetClass()->number_of_all_relationships();
 
  while (l1 < l2) {
    OksDataInfo odi(l1, (OksRelationship*)0);
    OksData* d(obj->GetRelationshipValue(&odi));
 
    if (d->type == OksData::object_type) {
      if (OksObject* o2 = d->data.OBJECT) {
        insert2refs(o2, recursion_depth, data);
      }
    } else if (d->type == OksData::list_type) {
      for (OksData::List::const_iterator li = d->data.LIST->begin(); li != d->data.LIST->end(); ++li) {
        if ((*li)->type == OksData::object_type) {
          if (OksObject* o2 = (*li)->data.OBJECT) {
            insert2refs(o2, recursion_depth, data);
          }
        }
      }
    }
 
    ++l1;
  }
}

add_if_not_found()

void dunedaq::oks::add_if_not_found ( OksClass::FList & clist, OksClass * c )

inline

Definition at line 1525 of file class.cpp.

{
  for (OksClass::FList::const_iterator i = clist.begin(); i != clist.end(); ++i) {
    if (*i == c)
      return;
  }
  clist.push_back(c);
}

add_super_class_error()

std::string dunedaq::oks::add_super_class_error ( const std::string & c1, const std::string & c2 )

static

Definition at line 824 of file class.cpp.

{
  return (std::string("cannot add superclass \"") + c1 + "\" to class \"" + c2 + '\"');
}

are_types_different()

bool dunedaq::oks::are_types_different ( const OksAttribute * a1, const OksAttribute * a2 )

inline

Definition at line 1607 of file class.cpp.

{
  static const std::string __enum_str__("enum");
  static const std::string __string_str__("string");
 
  const std::string& s1 = a1->get_type();
  const std::string& s2 = a2->get_type();
 
  return (
    !((s1 == s2) || ((s1 == __enum_str__ && s2 == __string_str__) || (s1 == __string_str__ && s2 == __enum_str__))));
}

bool2value_type()

const char * dunedaq::oks::bool2value_type ( bool v )

inline

Definition at line 1599 of file class.cpp.

{
  return (v ? "multi-value" : "single-value");
}

card2string()

const char * dunedaq::oks::card2string ( OksRelationship::CardinalityConstraint cc )

inline

Definition at line 1697 of file class.cpp.

{
  return (cc == OksRelationship::One ? "one object" : "many objects");
}

check_and_report_empty_parameter()

void dunedaq::oks::check_and_report_empty_parameter ( const char * fname, bool b1, bool b2 )

static

Definition at line 781 of file class.cpp.

{
  if (b1) {
    throw oks::SetOperationFailed(fname, "First parameter is (null)");
  }
 
  if (b2) {
    throw oks::SetOperationFailed(fname, "Second parameter is (null)");
  }
}

check_and_report_found_items()

void dunedaq::oks::check_and_report_found_items ( const char * fname, const char * item_type, const std::string & item1_name, const std::string & item2_name, const std::string & class_name, bool b1, bool b2 )

static

Definition at line 795 of file class.cpp.

{
  struct
  {
    bool b;
    const std::string* name;
  } info[] = { { b1, &item1_name }, { b2, &item2_name } };
 
  for (int i = 0; i < 2; ++i) {
    if (info[i].b) {
      std::string text("cannot find direct ");
      text += item_type;
      text += " \"";
      text += *info[i].name;
      text += "\" in class \"";
      text += class_name;
      text += '\"';
      throw oks::SetOperationFailed(fname, text);
    }
  }
}

check_relevant()

bool dunedaq::oks::check_relevant ( const std::set< std::string > & loaded_files, const OksRepositoryVersion & ver )

static

Definition at line 5093 of file kernel.cpp.

{
  for (const auto& x : ver.m_files)
    if (loaded_files.find(x) != loaded_files.end())
      return true;
 
  return false;
}

cmp_data()

bool dunedaq::oks::cmp_data ( OksData * d, OksData * d2 )

static

Definition at line 2197 of file object.cpp.

{
  if (d->type == OksData::object_type && d2->type == OksData::object_type)
    return ((d2->data.OBJECT == d->data.OBJECT) ? true : false);
 
  const std::string& object_id = d->type == OksData::object_type ? d->data.OBJECT->GetId()
                                 : d->type == OksData::uid2_type ? *(static_cast<std::string*>(d->data.UID2.object_id))
                                                                 : *(static_cast<std::string*>(d->data.UID.object_id));
 
  const std::string& object_id2 = d2->type == OksData::object_type ? d2->data.OBJECT->GetId()
                                  : d2->type == OksData::uid2_type
                                    ? *(static_cast<std::string*>(d2->data.UID2.object_id))
                                    : *(static_cast<std::string*>(d2->data.UID.object_id));
 
  if (object_id != object_id2)
    return false;
 
  const OksClass* pclass_id = d->type == OksData::object_type ? d->data.OBJECT->GetClass()
                              : d->type == OksData::uid_type  ? d->data.UID.class_id
                                                              : 0;
 
  const OksClass* pclass_id2 = d2->type == OksData::object_type ? d2->data.OBJECT->GetClass()
                               : d2->type == OksData::uid_type  ? d2->data.UID.class_id
                                                                : 0;
 
  if (pclass_id && pclass_id2)
    return (pclass_id == pclass_id2 ? true : false);
 
  const std::string& class_id =
    (pclass_id ? pclass_id->get_name() : *(static_cast<std::string*>(d->data.UID2.class_id)));
 
  const std::string& class_id2 =
    (pclass_id2 ? pclass_id2->get_name() : *(static_cast<std::string*>(d2->data.UID2.class_id)));
 
  return (class_id == class_id2 ? true : false);
}

cmp_str1()

bool dunedaq::oks::cmp_str1 ( const char * s1, const char s2[2] )

inline

Definition at line 15 of file cstring.hpp.

{
  return (*(const int16_t*)s1 == *(const int16_t*)s2);
}

cmp_str10()

bool dunedaq::oks::cmp_str10 ( const char * s1, const char s2[11] )

inline

Definition at line 111 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str2(s1 + 8, s2 + 8);
}

cmp_str11()

bool dunedaq::oks::cmp_str11 ( const char * s1, const char s2[12] )

inline

Definition at line 117 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str3(s1 + 8, s2 + 8);
}

cmp_str12()

bool dunedaq::oks::cmp_str12 ( const char * s1, const char s2[13] )

inline

Definition at line 123 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str4(s1 + 8, s2 + 8);
}

cmp_str13()

bool dunedaq::oks::cmp_str13 ( const char * s1, const char s2[14] )

inline

Definition at line 129 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str5(s1 + 8, s2 + 8);
}

cmp_str14()

bool dunedaq::oks::cmp_str14 ( const char * s1, const char s2[14] )

inline

Definition at line 135 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str6(s1 + 8, s2 + 8);
}

cmp_str15()

bool dunedaq::oks::cmp_str15 ( const char * s1, const char s2[16] )

inline

Definition at line 141 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str7(s1 + 8, s2 + 8);
}

cmp_str16()

bool dunedaq::oks::cmp_str16 ( const char * s1, const char s2[17] )

inline

Definition at line 147 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && cmp_str7(s1 + 8, s2 + 8) && (s1[16] == 0);
}

cmp_str2()

bool dunedaq::oks::cmp_str2 ( const char * s1, const char s2[3] )

inline

Definition at line 21 of file cstring.hpp.

{
  return cmp_str1(s1, s2) && (s1[2] == 0);
}

cmp_str2n()

bool dunedaq::oks::cmp_str2n ( const char * s1, const char s2[2] )

inline

Definition at line 27 of file cstring.hpp.

{
  return cmp_str1(s1, s2);
}

cmp_str3()

bool dunedaq::oks::cmp_str3 ( const char * s1, const char s2[4] )

inline

Definition at line 33 of file cstring.hpp.

{
  return (*(const int32_t*)s1 == *(const int32_t*)s2);
}

cmp_str3n()

bool dunedaq::oks::cmp_str3n ( const char * s1, const char s2[3] )

inline

Definition at line 39 of file cstring.hpp.

{
  return (s1[0] == s2[0]) && cmp_str1(s1 + 1, s2 + 1);
}

cmp_str4()

bool dunedaq::oks::cmp_str4 ( const char * s1, const char s2[5] )

inline

Definition at line 45 of file cstring.hpp.

{
  return (s1[0] == s2[0]) && cmp_str3(s1 + 1, s2 + 1);
}

cmp_str4n()

bool dunedaq::oks::cmp_str4n ( const char * s1, const char s2[4] )

inline

Definition at line 51 of file cstring.hpp.

{
  return cmp_str3(s1, s2);
}

cmp_str5()

bool dunedaq::oks::cmp_str5 ( const char * s1, const char s2[6] )

inline

Definition at line 57 of file cstring.hpp.

{
  return cmp_str1(s1, s2) && cmp_str3(s1 + 2, s2 + 2);
}

cmp_str5n()

bool dunedaq::oks::cmp_str5n ( const char * s1, const char s2[5] )

inline

Definition at line 63 of file cstring.hpp.

{
  return cmp_str3(s1, s2) && (s1[4] == s2[4]);
}

cmp_str6()

bool dunedaq::oks::cmp_str6 ( const char * s1, const char s2[7] )

inline

Definition at line 69 of file cstring.hpp.

{
  return cmp_str3(s1, s2) && cmp_str2(s1 + 4, s2 + 4);
}

cmp_str6n()

bool dunedaq::oks::cmp_str6n ( const char * s1, const char s2[6] )

inline

Definition at line 75 of file cstring.hpp.

{
  return cmp_str3(s1, s2) && cmp_str1(s1 + 4, s2 + 4);
}

cmp_str7()

bool dunedaq::oks::cmp_str7 ( const char * s1, const char s2[8] )

inline

Definition at line 81 of file cstring.hpp.

{
  return (*(const int64_t*)s1 == *(const int64_t*)s2);
}

cmp_str7n()

bool dunedaq::oks::cmp_str7n ( const char * s1, const char s2[8] )

inline

Definition at line 87 of file cstring.hpp.

{
  return (cmp_str3(s1, s2) && cmp_str3n(s1 + 4, s2 + 4));
}

cmp_str8()

bool dunedaq::oks::cmp_str8 ( const char * s1, const char s2[9] )

inline

Definition at line 93 of file cstring.hpp.

{
  return cmp_str7(s1, s2) && (s1[8] == 0);
}

cmp_str8n()

bool dunedaq::oks::cmp_str8n ( const char * s1, const char s2[9] )

inline

Definition at line 99 of file cstring.hpp.

{
  return (*(const int64_t*)s1 == *(const int64_t*)s2);
}

cmp_str9()

bool dunedaq::oks::cmp_str9 ( const char * s1, const char s2[10] )

inline

Definition at line 105 of file cstring.hpp.

{
  return cmp_str1(s1, s2) && cmp_str7(s1 + 2, s2 + 2);
}

create_updated_lists()

void dunedaq::oks::create_updated_lists ( const OksFile::Map & files, std::list< OksFile * > ** ufs, std::list< OksFile * > ** rfs, OksFile::FileStatus wu, OksFile::FileStatus wr )

static

Definition at line 2774 of file kernel.cpp.

{
  *ufs = 0; // updated files
  *rfs = 0; // removed files
 
  for (OksFile::Map::const_iterator i = files.begin(); i != files.end(); ++i) {
    OksFile::FileStatus fs = i->second->get_status_of_file();
 
    if (fs == wu /* i.e. Which Updated */) {
      if (*ufs == 0) {
        *ufs = new std::list<OksFile*>();
      }
      (*ufs)->push_back(i->second);
    } else if (fs == wr /* i.e. Which Removed */) {
      if (*rfs == 0) {
        *rfs = new std::list<OksFile*>();
      }
      (*rfs)->push_back(i->second);
    }
  }
}

erase_empty_chars()

void dunedaq::oks::erase_empty_chars ( std::string & s )

inline

Definition at line 110 of file query.cpp.

{
  while (s[0] == ' ' || s[0] == '\n' || s[0] == '\t')
    s.erase(0, 1);
}

ERS_DECLARE_ISSUE()

dunedaq::oks::ERS_DECLARE_ISSUE	(	kernel	,
		SetGroupIdFailed	,
		"cannot set group ID "<< id<< " for the file \'"<< file<< "\': chown() failed with code "<< code<< "	)

get_file_length()

long dunedaq::oks::get_file_length ( std::ifstream & f )

static

Definition at line 446 of file kernel.cpp.

{
  long file_length = 0;
 
  // get size of file and check that it is not empty
 
  f.seekg(0, std::ios::end);
 
#if __GNUC__ >= 3
  file_length = static_cast<std::streamoff>(f.tellg());
#else
  file_length = f.tellg();
#endif
 
  f.seekg(0, std::ios::beg);
 
  return file_length;
}

get_time_interval()

double dunedaq::oks::get_time_interval	(	const timeval *	t1,
		const timeval *	t2 )

insert2refs()

void dunedaq::oks::insert2refs ( const OksObject * o, unsigned long recursion_depth, RefData & data )

static

Definition at line 2993 of file object.cpp.

{
  recursion_depth--;
 
  std::pair<OksObject::FSet::iterator, bool> ret = data.tested_objs.insert(const_cast<OksObject*>(o));
 
  if (ret.second == true) {
    if (data.classes == nullptr || data.classes->find(const_cast<OksClass*>(o->GetClass())) != data.classes->end()) {
      data.refs.insert(const_cast<OksObject*>(o));
    }
    o->SetTransientData((void*)recursion_depth);
    _references(o, recursion_depth, data);
  } else if (o->GetTransientData() < (void*)recursion_depth) {
    o->SetTransientData((void*)recursion_depth);
    _references(o, recursion_depth, data);
  }
}

is_not_info()

bool dunedaq::oks::is_not_info ( const std::string & line )

static

Definition at line 1480 of file file.cpp.

{
  static const char start_tag[] = "<info ";
  static const char last_tag[] =
    "last-modification-time=\"yyyymmddThhmmss\"/>"; // 24 - is a position of first double quote
 
  const std::string::size_type len = line.length();
 
  return ((len < (sizeof(start_tag) + sizeof(last_tag))) ||
          (line.compare(0, sizeof(start_tag) - 1, start_tag, sizeof(start_tag) - 1) != 0) ||
          (line.compare(len - sizeof(last_tag) + 1, 24, last_tag, 24) != 0));
}

is_star()

bool dunedaq::oks::is_star ( const std::string & s )

inline

Definition at line 750 of file attribute.cpp.

{
  return (s.size() == 1 && s[0] == '*');
}

log_timestamp()

std::ostream & dunedaq::oks::log_timestamp

(

__LogSeverity__

severity = Log

)

Definition at line 5470 of file kernel.cpp.

{
  auto now(std::chrono::system_clock::now());
  auto time_since_epoch(now.time_since_epoch());
  auto seconds_since_epoch(std::chrono::duration_cast<std::chrono::seconds>(time_since_epoch));
 
  std::time_t now_t(std::chrono::system_clock::to_time_t(std::chrono::system_clock::time_point(seconds_since_epoch)));
 
  char buff[128];
  std::size_t len = std::strftime(buff, 128 - 16, "%Y-%b-%d %H:%M:%S.", std::localtime(&now_t));
  sprintf(buff + len,
          "%03d ",
          (int)(std::chrono::duration_cast<std::chrono::milliseconds>(time_since_epoch).count() -
                seconds_since_epoch.count() * 1000));
 
  std::ostream& s(severity <= Warning ? std::cerr : std::cout);
 
  s << buff << (severity == Error ? "ERROR " : severity == Warning ? "WARNING " : severity == Debug ? "DEBUG " : "");
 
  return s;
}

make_fname()

std::string dunedaq::oks::make_fname	(	const char *	f,
		size_t	f_len,
		const std::string &	file,
		bool *	p,
		const OksFile *const *	fh )

Definition at line 468 of file kernel.cpp.

{
  const char _prefix[] = "OksKernel::";
  std::string fname(_prefix, (sizeof(_prefix) - 1));
 
  fname.append(f, f_len);
 
  const char _x1[] = "(file \'";
  fname.append(_x1, (sizeof(_x1) - 1));
  fname.append(file);
  fname.push_back('\'');
 
  // add boolean parameter
 
  if (p) {
    if (*p) {
      const char _true_str[] = ", true";
      fname.append(_true_str, (sizeof(_true_str) - 1));
    } else {
      const char _false_str[] = ", false";
      fname.append(_false_str, (sizeof(_false_str) - 1));
    }
  }
 
  // add file handler parameter
 
  if (fh && *fh) {
    const char _x2[] = ", included by file \'";
    fname.append(_x2, (sizeof(_x2) - 1));
    fname.append((*fh)->get_full_file_name());
    fname.push_back('\'');
  }
 
  fname.push_back(')');
 
  return fname;
}

mk_name_and_test()

std::string dunedaq::oks::mk_name_and_test ( const std::string & name, const char * test, size_t test_len )

inline

Definition at line 1492 of file kernel.cpp.

{
  const char _s1_str[] = " - \'";
  const char _s2_str[] = "\' tested as ";
 
  return ((std::string(_s1_str, sizeof(_s1_str) - 1) + name).append(_s2_str, sizeof(_s2_str) - 1))
    .append(test, test_len);
}

operator<()

bool dunedaq::oks::operator< ( const OksString & s1, const OksString & s2 )

inline

Implementation of OksString logical less operator.

Definition at line 476 of file object.hpp.

{
  return (*(static_cast<const std::string*>(&s1)) < *(static_cast<const std::string*>(&s2)));
}

operator<<() [1/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const Date &	d )

Definition at line 162 of file time.cpp.

{
  std::string str = d.str();
  s << str;
  return s;
}

operator<<() [2/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const oks::Comment &	c )

Definition at line 1269 of file file.cpp.

{
  s << "user \"" << c.get_created_by() << "\" (" << c.get_author() << ")"
    << " on \"" << c.get_created_on() << "\" wrote: \"" << c.get_text() << "\"";
 
  return s;
}

operator<<() [3/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const oks::QueryPath &	query )

Definition at line 896 of file query.cpp.

{
  s << '(' << OksQuery::PATH_TO << ' ' << query.get_goal_object() << ' ' << *query.get_start_expression() << ')';
  return s;
}

operator<<() [4/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const oks::QueryPathExpression &	e )

Definition at line 903 of file query.cpp.

{
  s << '(' << (e.get_use_nested_lookup() ? OksQuery::NESTED : OksQuery::DIRECT) << ' ';
 
  for (std::list<std::string>::const_iterator i = e.get_rel_names().begin(); i != e.get_rel_names().end(); ++i) {
    if (i != e.get_rel_names().begin())
      s << ' ';
    s << '\"' << *i << '\"';
  }
 
  if (e.get_next())
    s << ' ' << *(e.get_next());
 
  s << ')';
 
  return s;
}

operator<<() [5/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksFile &	f )

Definition at line 1278 of file file.cpp.

{
  s << "OKS file\n"
       " short file name:        \'"
    << f.get_short_file_name()
    << "\'\n"
       " full file name:         \'"
    << f.get_full_file_name()
    << "\'\n"
       " lock file name:         \'"
    << f.get_lock_file()
    << "\'\n"
       " logical name:           \'"
    << f.get_logical_name()
    << "\'\n"
       " type:                   \'"
    << f.get_type()
    << "\'\n"
       " oks format:             \'"
    << f.get_oks_format()
    << "\'\n"
       " number of items:        "
    << f.get_number_of_items()
    << "\n"
       " created by:             "
    << f.get_created_by()
    << "\n"
       " creation time:          "
    << boost::posix_time::to_simple_string(f.get_creation_time())
    << "\n"
       " created on:             "
    << f.get_created_on()
    << "\n"
       " last modified by:       \'"
    << f.get_last_modified_by()
    << "\'\n"
       " last modification time: "
    << boost::posix_time::to_simple_string(f.get_last_modification_time())
    << "\'\n"
       " last modified on:       "
    << f.get_last_modified_on()
    << "\'\n"
       " is "
    << (f.is_read_only() ? "read-only" : "read-write")
    << "\n"
       " is "
    << (f.is_locked() ? "" : "not ")
    << "locked\n"
       " is "
    << (f.is_updated() ? "" : "not ") << "updated\n";
 
  {
    size_t num_of_includes = f.get_include_files().size();
 
    if (num_of_includes) {
      s << " contains " << num_of_includes << " include file(s)";
      for (const auto& i : f.get_include_files())
        s << "  - \'" << i << "\'\n";
    } else {
      s << " contains no include files\n";
    }
  }
 
  {
    size_t num_of_comments = f.get_comments().size();
 
    if (num_of_comments) {
      s << " contains " << num_of_comments << " comment(s)";
      for (const auto& i : f.get_comments())
        s << "  - " << boost::posix_time::to_simple_string(boost::posix_time::from_iso_string(i.first)) << ": \'"
          << *i.second << "\'\n";
    } else {
      s << " contains no comments\n";
    }
  }
 
  s << "END of oks file\n";
 
  return s;
}

operator<<() [6/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const Time &	t )

Definition at line 170 of file time.cpp.

{
  std::string str = t.str();
  s << str;
  return s;
}

operator<<() [7/19]

std::ostream & dunedaq::oks::operator<< ( std::ostream & s, const oks::exception & ex )

inline

Definition at line 39 of file exceptions.hpp.

{
  s << ex.what();
  return s;
}

operator<<() [8/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksAttribute &	a )

Definition at line 235 of file attribute.cpp.

{
  s << "Attribute name: \"" << a.p_name
    << "\"\n"
       " type: \""
    << a.get_type()
    << "\"\n"
       " range: \""
    << a.p_range << "\"\n";
 
  if (a.is_integer()) {
    s << " format: \"" << OksAttribute::format2str(a.p_format) << "\"\n";
  }
 
  if (a.p_multi_values == true) {
    s << " is \'multi values\'\n";
  } else {
    s << " is \'single value\'\n";
  }
 
  s << " initial value: \"" << a.p_init_value
    << "\"\n"
       " has description: \""
    << a.p_description << "\"\n"
    << (a.p_no_null == true ? " can not be null\n" : " can be null\n") << " is "
    << (a.p_ordered == true ? "ordered" : "unordered") << std::endl;
 
  return s;
}

operator<<() [9/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksClass &	c )

Send to stream complete description of OKS class:

• print class name
• print details of attributes, relationships and methods
• print details of objects

Definition at line 380 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassOperatorOut, c.p_kernel)
 
  s << "Class name: \"" << c.p_name
    << "\"\n"
       " has description: \""
    << c.p_description << "\"\n"
    << (c.p_abstract == true ? " is abstract\n" : " is not abstract\n");
 
  if (c.p_super_classes) {
    s << "The class has superclasses:\n";
    for (std::list<std::string*>::const_iterator i = c.p_super_classes->begin(); i != c.p_super_classes->end(); ++i) {
      s << " - " << *(*i) << std::endl;
    }
  } else
    s << "The class has no superclasses\n";
 
  if (c.p_attributes) {
    s << "The attributes are:\n";
    for (std::list<OksAttribute*>::const_iterator i = c.p_attributes->begin(); i != c.p_attributes->end(); ++i) {
      s << *(*i);
    }
  } else
    s << "There are no attributes\n";
 
  if (c.p_relationships) {
    s << "The relationships are:\n";
    for (std::list<OksRelationship*>::const_iterator i = c.p_relationships->begin(); i != c.p_relationships->end();
         ++i) {
      s << *(*i);
    }
  } else
    s << "There are no relationships\n";
 
  if (c.p_methods) {
    s << "The methods are:\n";
    for (std::list<OksMethod*>::const_iterator i = c.p_methods->begin(); i != c.p_methods->end(); ++i) {
      s << *(*i);
    }
  } else
    s << "There are no methods\n";
 
  if (c.p_objects) {
    OksObject::SMap sorted;
 
    s << "The objects are:\n";
 
    for (OksObject::Map::iterator i = c.p_objects->begin(); i != c.p_objects->end(); ++i) {
      sorted[i->first] = i->second;
    }
 
    for (OksObject::SMap::iterator i = sorted.begin(); i != sorted.end(); ++i) {
      s << *(i->second);
    }
  } else
    s << "There are no objects\n";
 
  s << "End of Class \"" << c.p_name << "\"\n";
 
  return s;
}

operator<<() [10/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksMethod &	m )

Definition at line 191 of file method.cpp.

{
  s << "Method name: \"" << m.p_name
    << "\"\n"
       " description: \""
    << m.p_description << "\"\n";
 
  if (m.p_implementations) {
    s << " implementations:\n";
 
    for (std::list<OksMethodImplementation*>::const_iterator i = m.p_implementations->begin();
         i != m.p_implementations->end();
         ++i)
      s << *(*i);
  } else
    s << " there are no implementation(s)\n";
 
  return s;
}

operator<<() [11/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksMethodImplementation &	i )

Definition at line 47 of file method.cpp.

{
  s << "  Method implementation:\n"
       "    language:  \""
    << i.get_language()
    << "\"\n"
       "    prototype: \""
    << i.get_prototype()
    << "\"\n"
       "    body:      \""
    << i.get_body() << "\"\n";
 
  return s;
}

operator<<() [12/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksObject &	o )

Send to stream complete description of OKS object:

• print class name and ID
• print value of all attributes and relationships

Definition at line 1624 of file object.cpp.

{
  OSK_PROFILING(OksProfiler::ObjectOperatorOut, o.uid.class_id->p_kernel)
 
  const OksClass* c = o.uid.class_id;
 
  s << "Object " << &o << std::endl;
 
  OksData* di = o.data;
 
  // print attributes
 
  {
    const std::list<OksAttribute*>* alist = c->all_attributes();
 
    if (alist && !alist->empty()) {
      s << " Attributes are:\n";
 
      for (std::list<OksAttribute*>::const_iterator i = alist->begin(); i != alist->end(); ++i) {
        if ((*i)->is_integer() && (*i)->get_format() != OksAttribute::Dec) {
          s.setf(((*i)->get_format() == OksAttribute::Hex ? std::ios::hex : std::ios::oct), std::ios::basefield);
          s.setf(std::ios::showbase);
        }
 
        s << "  " << (*i)->get_name() << ": " << *di++ << std::endl;
 
        if ((*i)->is_integer() && (*i)->get_format() != OksAttribute::Dec) {
          s.setf(std::ios::dec, std::ios::basefield);
          s.unsetf(std::ios::showbase);
        }
      }
    } else
      s << " There are no attributes\n";
  }
 
  // print relationships
 
  {
    const std::list<OksRelationship*>* rlist = c->all_relationships();
 
    if (rlist && !rlist->empty()) {
      s << " Relationships are:\n";
 
      for (std::list<OksRelationship*>::const_iterator i = rlist->begin(); i != rlist->end(); ++i)
        s << "  " << (*i)->get_name() << ": " << *di++ << std::endl;
    } else
      s << " There are no relationships\n";
  }
 
  return s;
}

operator<<() [13/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksObject *	o )

Send to stream OKS object reference in format "foo@bar" (i.e. object "foo" from class "bar")

Definition at line 1609 of file object.cpp.

{
  s << '\"';
 
  if (o)
    s << o->GetId() << '@' << o->GetClass()->get_name();
  else
    s << "(null-obj)";
 
  s << '\"';
 
  return s;
}

operator<<() [14/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksProfiler &	t )

Definition at line 92 of file profiler.cpp.

{
  const int p = s.precision(4);
 
  printTableLine(s, '=');
 
  s << '|';
  s.fill(' ');
  s.width(76);
  s.setf(std::ios::left, std::ios::adjustfield);
  s << " O K S  P R O F I L E R " << '|' << std::endl;
 
  printTableLine(s, '-');
 
  s << "| Time: ";
  s.setf(std::ios::right, std::ios::adjustfield);
  s << std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() - t.p_start_time_point)
           .count() /
         1000.;
  s.fill(' ');
  s.width(64);
  s.setf(std::ios::left, std::ios::adjustfield);
  s << " seconds" << '|' << std::endl;
 
  printTableSeparator(s, '-');
 
  s.fill(' ');
  s.width(42);
  s << "| Function name" << '|';
  s.width(12);
  s << " # of calls" << '|';
  s.width(10);
  s << " total T," << '|';
  s.width(10);
  s << " ~T/call," << '|' << std::endl;
 
  s.fill(' ');
  s.width(42);
  s << '|' << "" << '|';
  s.width(12);
  s << "" << '|';
  s.width(10);
  s << " ms" << '|';
  s.width(10);
  s << " µs" << '|' << std::endl;
 
  for (short i = 0; i <= (short)OksProfiler::QueryOperatorFrom; i++) {
    if (i == 0 || i == 12 || i == 21 || i == 32)
      printTableSeparator(s, '-');
 
    s << "| ";
 
    s.width(40);
    s.fill(' ');
    s.setf(std::ios::left, std::ios::adjustfield);
    s << OksProfilerFunctionsStr[i] << '|';
 
    s.width(11);
    s.setf(std::ios::right, std::ios::adjustfield);
    s << t.c_total[i] << ' ' << '|';
 
    if (t.c_total[i]) {
      s.width(9);
      s << t.t_total[i] / 1000. << ' ' << '|';
 
      s.width(9);
      s << t.t_total[i] / (double)t.c_total[i];
    } else {
      s.width(10);
      s << " - " << '|';
 
      s.width(9);
      s << " -";
    }
 
    s << " |\n";
  }
 
  printTableSeparator(s, '=');
 
  s.precision(p);
 
  return s;
}

operator<<() [15/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksQuery &	gqe )

Definition at line 881 of file query.cpp.

{
  s << '(' << (gqe.p_sub_classes ? OksQuery::ALL_SUBCLASSES : OksQuery::THIS_CLASS) << ' ';
 
  if (gqe.p_expression)
    s << *gqe.p_expression;
  else
    s << "(null)";
 
  s << ')';
 
  return s;
}

operator<<() [16/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksQueryExpression &	qe )

Definition at line 760 of file query.cpp.

{
  s << '(';
 
  switch (qe.type()) {
    case OksQuery::comparator_type: {
      OksComparator* cmpr = (OksComparator*)&qe;
      const OksAttribute* a = cmpr->GetAttribute();
      OksData* v = cmpr->GetValue();
      OksQuery::Comparator f = cmpr->GetFunction();
 
      if (a) {
        s << '\"' << a->get_name() << "\" ";
      } else if (v) {
        s << OksQuery::OID << ' ';
      } else {
        s << "(null) ";
      }
 
      if (v) {
        s << *v << ' ';
      } else {
        s << "(null) ";
      }
 
      if (f) {
        if (f == OksQuery::equal_cmp)
          s << OksQuery::EQ;
        else if (f == OksQuery::not_equal_cmp)
          s << OksQuery::NE;
        else if (f == OksQuery::reg_exp_cmp)
          s << OksQuery::RE;
        else if (f == OksQuery::less_or_equal_cmp)
          s << OksQuery::LE;
        else if (f == OksQuery::greater_or_equal_cmp)
          s << OksQuery::GE;
        else if (f == OksQuery::less_cmp)
          s << OksQuery::LS;
        else if (f == OksQuery::greater_cmp)
          s << OksQuery::GT;
      } else
        s << "(null)";
 
      break;
    }
 
    case OksQuery::relationship_type: {
      OksRelationshipExpression* re = (OksRelationshipExpression*)&qe;
      const OksRelationship* r = re->GetRelationship();
      bool b = re->IsCheckAllObjects();
      OksQueryExpression* rqe = re->get();
 
      if (r)
        s << '\"' << r->get_name() << "\" ";
      else
        s << "(null) ";
 
      s << (b == true ? OksQuery::ALL_SUBCLASSES : OksQuery::SOME) << ' ';
 
      if (rqe)
        s << *rqe;
      else
        s << "(null)";
 
      break;
    }
 
    case OksQuery::not_type:
      s << OksQuery::NOT << ' ' << *(((OksNotExpression*)&qe)->get());
 
      break;
 
    case OksQuery::and_type: {
      s << OksQuery::AND << ' ';
 
      const std::list<OksQueryExpression*>& elist = ((OksAndExpression*)&qe)->expressions();
 
      if (!elist.empty()) {
        const OksQueryExpression* last = elist.back();
 
        for (std::list<OksQueryExpression*>::const_iterator i = elist.begin(); i != elist.end(); ++i) {
          s << *(*i);
          if (*i != last)
            s << ' ';
        }
      }
 
      break;
    }
 
    case OksQuery::or_type: {
      s << OksQuery::OR << ' ';
 
      const std::list<OksQueryExpression*>& elist = ((OksOrExpression*)&qe)->expressions();
 
      if (!elist.empty()) {
        const OksQueryExpression* last = elist.back();
 
        for (std::list<OksQueryExpression*>::const_iterator i = elist.begin(); i != elist.end(); ++i) {
          s << *(*i);
          if (*i != last)
            s << ' ';
        }
      }
 
      break;
    }
 
    case OksQuery::unknown_type: {
      s << "(unknown)";
 
      break;
    }
  }
 
  s << ')';
 
  return s;
}

operator<<() [17/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		const OksRelationship &	r )

Definition at line 90 of file relationship.cpp.

{
  s << "Relationship name: \"" << r.p_name
    << "\"\n"
       " class type: \""
    << r.p_rclass
    << "\"\n"
       " low cardinality constraint is "
    << OksRelationship::card2str(r.p_low_cc)
    << "\n"
       " high cardinality constraint is "
    << OksRelationship::card2str(r.p_high_cc)
    << "\n"
       " is"
    << (r.p_composite == true ? "" : " not")
    << " composite reference\n"
       " is"
    << (r.p_exclusive == true ? "" : " not")
    << " exclusive reference\n"
       " is "
    << (r.p_dependent == true ? "dependent" : "shared")
    << " reference\n"
       " has description: \""
    << r.p_description
    << "\"\n"
       " is "
    << (r.p_ordered == true ? "ordered" : "unordered") << std::endl;
 
  return s;
}

operator<<() [18/19]

std::ostream & dunedaq::oks::operator<< ( std::ostream & s, const OksString & str )

inline

Implementation of OksString out stream operator.

Definition at line 484 of file object.hpp.

{
  s << *(static_cast<const std::string*>(&str));
 
  return s;
}

operator<<() [19/19]

std::ostream & dunedaq::oks::operator<<	(	std::ostream &	s,
		OksKernel &	k )

Definition at line 1358 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelOperatorOut, &k)
 
  s << "OKS KERNEL DUMP:\n" << "OKS VERSION: " << k.GetVersion() << std::endl;
 
  if (!k.p_schema_files.empty()) {
    s << " Loaded schema:\n";
 
    for (const auto& i : k.p_schema_files)
      s << "   " << i.second->get_full_file_name() << std::endl;
 
    if (!k.p_data_files.empty()) {
      s << " Loaded data:\n";
 
      for (const auto& j : k.p_data_files)
        s << "   " << j.second->get_full_file_name() << std::endl;
    } else
      s << " No loaded data files\n";
 
    if (!k.p_classes.empty()) {
      s << " The classes:\n";
 
      for (const auto& j : k.p_classes)
        s << *j.second;
    }
  } else
    s << " No loaded schema files\n";
 
  s << "END OF OKS KERNEL DUMP.\n";
 
  return s;
}

operator==() [1/3]

bool dunedaq::oks::operator== ( const OksString & s1, const char * s2 )

inline

Implementation of OksString logical equality operator.

Definition at line 469 of file object.hpp.

{
  return (*(static_cast<const std::string*>(&s1)) == s2);
}

operator==() [2/3]

bool dunedaq::oks::operator== ( const OksString & s1, const OksString & s2 )

inline

Implementation of OksString logical equality operator.

Definition at line 453 of file object.hpp.

{
  return (*(static_cast<const std::string*>(&s1)) == *(static_cast<const std::string*>(&s2)));
}

operator==() [3/3]

bool dunedaq::oks::operator== ( const OksString & s1, const std::string & s2 )

inline

Implementation of OksString logical equality operator.

Definition at line 461 of file object.hpp.

{
  return (*(static_cast<const std::string*>(&s1)) == s2);
}

printTableLine()

void dunedaq::oks::printTableLine ( std::ostream & s, unsigned char c )

static

Definition at line 84 of file profiler.cpp.

{
  s << '+';
  s.fill(c);
  s.width(76);
  s << "" << '+' << std::endl;
}

printTableSeparator()

void dunedaq::oks::printTableSeparator ( std::ostream & s, unsigned char c )

static

Definition at line 69 of file profiler.cpp.

{
  s << '+';
  s.fill(c);
  s.width(41);
  s << "" << '+';
  s.width(12);
  s << "" << '+';
  s.width(10);
  s << "" << '+';
  s.width(10);
  s << "" << '+' << std::endl;
}

reference()

Found unresolved dunedaq::oks::reference

(

s

)

Definition at line 124 of file kernel.cpp.

                                                                   :\n" << which, ((std::string)which))
 
ERS_DECLARE_ISSUE(kernel,
                  ClassAlreadyDefined,
                  "class \"" << name << "\" is defined in files \"" << f1 << "\" and \"" << f2 << "\"",
                  ((std::string)name)((std::string)f1)((std::string)f2))
 
ERS_DECLARE_ISSUE(kernel, InternalError, "internal error: " << text, ((std::string)text))
 
std::string
CanNotOpenFile::fill(const char* prefix, const std::string& name, const std::string& reason) noexcept
{
  std::string result(prefix);
  result += "(): ";
 
  if (name.empty())
    return (result + "file name is empty");
 
  result += "cannot load file \'" + name + '\'';
 
  if (!reason.empty()) {
    result += " because:\n" + reason;
  }
 
  return result;
}
 
std::string
FailedLoadFile::fill(const std::string& what, const std::string& name, const std::string& reason) noexcept
{
  return (std::string("Failed to load ") + what + " \"" + name + "\" because:\n" + reason);
}
 
std::string
FailedReloadFile::fill(const std::string& names, const std::string& reason) noexcept
{
  return (std::string("Failed to re-load file(s) ") + names + " because:\n" + reason);
}
 
std::string
RepositoryOperationFailed::fill(const char* op, const std::string& reason) noexcept
{
  return (std::string("Failed to ") + op + " file(s) because:\n" + reason);
}
 
std::string
CanNotCreateFile::fill(const char* prefix,
                       const char* what,
                       const std::string& name,
                       const std::string& reason) noexcept
{
  return std::string(prefix) + "(): failed to create new " + what + " \'" + name + "\' because:\n" + reason;
}
 
std::string
CanNotCreateRepositoryDir::fill(const char* prefix, const std::string& name) noexcept
{
  return std::string(prefix) + "(): failed to create user repository dir, mkdtemp(\'" + name +
         "\') failed: " + strerror(errno);
}
 
std::string
CanNotWriteToFile::fill(const char* prefix,
                        const char* item,
                        const std::string& name,
                        const std::string& reason) noexcept
{
  return (std::string(prefix) + "(): failed to write " + item + " to \'" + name + "\' because:\n" + reason);
}
 
std::string
CanNotBackupFile::fill(const std::string& name, const std::string& reason) noexcept
{
  return (std::string("Failed to make a backup file of \'") + name + "\' because:\n" + reason);
}
 
std::string
CanNotSetActiveFile::fill(const char* item, const std::string& name, const std::string& reason) noexcept
{
  return (std::string("Failed to set active ") + item + " file \'" + name + "\' because:\n" + reason);
}
 
std::string
CanNotSetFile::fill(const OksClass* c, const OksObject* o, const OksFile& file, const std::string& reason) noexcept
{
  std::ostringstream s;
  s << "Failed to move ";
  if (c)
    s << "class " << c->get_name();
  else
    s << "object " << o;
  s << " to file \'" << file.get_full_file_name() << "\' because:\n" << reason;
  return s.str();
}
 
std::string
CannotAddClass::fill(const OksClass& c, const std::string& reason) noexcept
{
  return (std::string("Cannot add class \'") + c.get_name() + "\' because:\n" + reason);
}
 
std::string
CannotResolvePath::fill(const std::string& path, int error_code) noexcept
{
  std::ostringstream text;
  text << "realpath(\'" << path << "\') has failed with code " << error_code << ": \'" << strerror(error_code) << '\'';
  return text.str();
}
 
static const std::string&
get_temporary_dir()
{
  static std::string s_dir;
  static std::once_flag flag;
 
  std::call_once(flag, []() {
    try {
      if (!getenv("OKS_GIT_NO_VAR_DIR")) {
        OksSystem::User myself;
 
        s_dir = "/var/run/user/";
        s_dir.append(std::to_string(myself.identity()));
 
        if (std::filesystem::is_directory(s_dir) == false) {
          TLOG_DEBUG(1) << "directory " << s_dir << " does not exist";
          s_dir.clear();
        } else {
          const std::filesystem::space_info si = std::filesystem::space(s_dir);
          const double available = static_cast<double>(si.available) / static_cast<double>(si.capacity);
 
          if (available < 0.5) {
            TLOG_DEBUG(1) << "usage of " << s_dir << " is " << static_cast<int>((1.0 - available) * 100.0)
                          << "%, will use standard temporary path";
            s_dir.clear();
          }
        }
      }
 
      if (s_dir.empty())
        s_dir = std::filesystem::temp_directory_path().string();
    } catch (std::exception& ex) {
      Oks::error_msg("OksKernel::OksKernel") << "cannot get temporary directory path: " << ex.what() << std::endl;
      s_dir = "/tmp";
    }
  });
 
  return s_dir;
}

remove_super_class_error()

std::string dunedaq::oks::remove_super_class_error ( const std::string & c1, const std::string & c2 )

static

Definition at line 881 of file class.cpp.

{
  return (std::string("cannot remove superclass \"") + c1 + "\" from class \"" + c2 + '\"');
}

replace_datetime_spaces()

std::string dunedaq::oks::replace_datetime_spaces ( const std::string & in )

static

Definition at line 5230 of file kernel.cpp.

{
  std::string out(in);
  std::replace(out.begin(), out.end(), ' ', 'T');
  return out;
}

report_unexpected()

std::string dunedaq::oks::report_unexpected ( const char * what, const char expected, const char read )

static

Definition at line 84 of file xml.cpp.

{
  std::string s;
 
  if (what) {
    s += "Failed to read ";
    s += what;
    s += ": ";
  }
 
  s += "symbol \'";
  s += expected;
  s += "\' is expected instead of \'";
  s += read;
  s += '\'';
 
  return s;
}

str2date()

boost::gregorian::date dunedaq::oks::str2date	(	const char *	value,
		size_t	len )

str2time()

boost::posix_time::ptime dunedaq::oks::str2time	(	const char *	value,
		size_t	len,
		const char *	file_name = nullptr )

strerror()

const std::string dunedaq::oks::strerror

(

int

error

)

Convert C error number to string.

Definition at line 111 of file kernel.cpp.

{
  char buffer[1024];
  buffer[0] = 0;
  return std::string(strerror_r(error, buffer, 1024));
}

test_dangling_references()

void dunedaq::oks::test_dangling_references ( const OksObject * obj, const OksData & d, const OksRelationship & r, std::string & result )

static

Definition at line 2872 of file object.cpp.

{
  if (d.type == OksData::uid_type || d.type == OksData::uid2_type) {
    std::ostringstream text;
 
    if (result.empty()) {
      text << " * object " << obj << " has dangling references:\n";
    }
 
    text << "  - object " << d << " referenced via \'" << r.get_name() << "\'\n";
 
    result += text.str();
  }
}

test_file_existence()

void dunedaq::oks::test_file_existence ( const std::string & file_name, bool silence, const std::string & fname, const char * msg )

static

Definition at line 1455 of file kernel.cpp.

{
  // test file existence
 
  bool file_exists = false;
 
  {
    struct stat buf;
    if (stat(file_name.c_str(), &buf) == 0) {
      if (!silence) {
        Oks::warning_msg(fname) << "  File \"" << file_name << "\" already exists\n";
      }
      file_exists = true;
    }
  }
 
  // test file permissions
 
  {
    std::ofstream f(file_name.c_str());
 
    if (!f) {
      if (!silence) {
        if (file_exists) {
          throw std::runtime_error("cannot open file in write mode");
        } else {
          throw std::runtime_error("cannot create file");
        }
      }
    }
  }
 
  if (!silence)
    std::cout << "Creating new " << msg << " file \"" << file_name << "\"..." << std::endl;
}

throw_validate_not_empty()

void dunedaq::oks::throw_validate_not_empty

(

const char *

name

)

Definition at line 50 of file xml.cpp.

{
  std::string text(name);
  text += " is not set";
  throw std::runtime_error(text.c_str());
}

trim_dangling()

bool dunedaq::oks::trim_dangling ( OksData & d, const OksKernel & kernel )

static

Definition at line 1683 of file object.cpp.

{
  if (d.type == OksData::object_type) {
    if (d.data.OBJECT && kernel.is_dangling(d.data.OBJECT)) {
      d.data.OBJECT = nullptr;
    }
 
    return (d.data.OBJECT != nullptr);
  } else if (d.type == OksData::list_type) {
    if (d.data.LIST) {
      for (OksData::List::iterator i = d.data.LIST->begin(); i != d.data.LIST->end();) {
        OksData* d2 = *i;
        if (d2->type == OksData::object_type) {
          if (d2->data.OBJECT == nullptr || kernel.is_dangling(d2->data.OBJECT)) {
            i = d.data.LIST->erase(i);
            delete d2;
            continue;
          }
        }
        ++i;
      }
 
      return (!d.data.LIST->empty());
    } else
      return false;
  }
 
  return true;
}

validate_init2range()

void dunedaq::oks::validate_init2range

(

const OksAttribute *

a

)

Definition at line 164 of file attribute.cpp.

{
  if (!a->get_range().empty() && a->get_data_type() != OksData::class_type) {
    try {
      OksData d;
      d.set_init_value(a, false);
      d.check_range(a);
    } catch (std::exception& ex) {
      std::ostringstream text;
      text << "failed to set initial value \'" << a->get_init_value() << "\' of attribute \'" << a->get_name()
           << "\':\n"
           << ex.what();
      throw std::runtime_error(text.str().c_str());
    }
  }
}

validate_not_empty()

void dunedaq::oks::validate_not_empty ( const std::string & value, const char * name )

inline

Check string value is not empty. Throw exception if length = 0.

Definition at line 52 of file exceptions.hpp.

{
  if (value.empty())
    throw_validate_not_empty(name);
}

Variable Documentation

_empty_str

const char dunedaq::oks::_empty_str[] = "empty"

Definition at line 354 of file file.cpp.

BindError

dunedaq::oks::BindError

Definition at line 124 of file kernel.cpp.

OksProfilerFunctionsStr

const char* dunedaq::oks::OksProfilerFunctionsStr[]

static

Definition at line 14 of file profiler.cpp.

s_get_cwd_mutex

std::mutex dunedaq::oks::s_get_cwd_mutex

static

Definition at line 57 of file kernel.cpp.

s_git_folders

GitFoldersHolder dunedaq::oks::s_git_folders

static

Definition at line 108 of file kernel.cpp.