Classes
class	JournalLogger

Functions
JournalLogger &	GetLogger ()

std::string	ToString (const wxString &str)

template<typename T >
std::string	ToString (const T &arg)

template<typename... Args>
void	Log (std::string_view message, const Args &... args)

void	NextIn ()

wxArrayStringEx	PeekTokens ()

wxString	VersionString ()

bool	VersionCheck (const wxString &value)
	True if value is an acceptable journal version number to be rerun. More...

Variables
wxString	sFileNameIn

wxTextFile	sFileIn

wxString	sLine

int	sLineNumber = -1

BoolSetting	JournalEnabled { L"/Journal/Enabled", false }

constexpr auto	VersionToken = wxT("Version")

int	journalVersionNumbers []

Function Documentation

◆ GetLogger()

JournalLogger & Journal::anonymous_namespace{Journal.cpp}::GetLogger ( )

Definition at line 69 of file Journal.cpp.

{
   static JournalLogger logger;
   return logger;
}

Referenced by Log().

Here is the caller graph for this function:

◆ Log()

template<typename... Args>

void Journal::anonymous_namespace{Journal.cpp}::Log	(	std::string_view	message,
		const Args &...	args
	)

Definition at line 87 of file Journal.cpp.

{
   if (message.empty())
      return;
 
   constexpr auto n = sizeof...(Args);
 
   std::string strings[n];
   std::size_t i = 0;
   ((strings[i++] = ToString(args)), ...);
   i = 0;
 
   auto& logger = GetLogger();
 
   while (!message.empty())
   {
      const auto placeholderPos = message.find("{}");
 
      if (placeholderPos == std::string_view::npos || i == n)
      {
         logger.WriteString(message);
         break;
      }
 
      std::string_view arg = strings[i++];
 
      logger.WriteString(message.substr(0, placeholderPos));
      logger.WriteString(arg);
 
      message = message.substr(placeholderPos + 2);
   }
 
   logger.FinalizeMessge();
}

References GetLogger(), Tuple::detail::npos(), and ToString().

Referenced by Journal::Begin(), NextIn(), and Journal::SyncException::SyncException().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NextIn()

void Journal::anonymous_namespace{Journal.cpp}::NextIn ( )

inline

Definition at line 122 of file Journal.cpp.

{
   if ( !sFileIn.Eof() ) {
      sLine = sFileIn.GetNextLine();
      ++sLineNumber;
 
      Log("Journal: line {} is '{}'", sLineNumber, sLine);
   }
}

References Log(), sFileIn, sLine, and sLineNumber.

Referenced by Journal::Begin(), Journal::GetExitCode(), Journal::GetTokens(), PeekTokens(), and Journal::Sync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PeekTokens()

wxArrayStringEx Journal::anonymous_namespace{Journal.cpp}::PeekTokens ( )

Definition at line 132 of file Journal.cpp.

{
   wxArrayStringEx tokens;
   if ( Journal::IsReplaying() )
      for ( ; !sFileIn.Eof(); NextIn() ) {
         if ( sLine.StartsWith( CommentCharacter ) )
            continue;
 
         tokens = wxSplit( sLine, SeparatorCharacter, EscapeCharacter );
         if ( tokens.empty() )
            // Ignore blank lines
            continue;
 
         break;
      }
   return tokens;
}

References Journal::CommentCharacter, Journal::EscapeCharacter, Journal::IsReplaying(), NextIn(), Journal::SeparatorCharacter, sFileIn, and sLine.

Referenced by Journal::Begin(), Journal::GetExitCode(), and Journal::GetTokens().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToString() [1/2]

template<typename T >

std::string Journal::anonymous_namespace{Journal.cpp}::ToString ( const T & arg )

Definition at line 81 of file Journal.cpp.

{
   return std::to_string(arg);
}

Referenced by Log().

Here is the caller graph for this function:

◆ ToString() [2/2]

std::string Journal::anonymous_namespace{Journal.cpp}::ToString ( const wxString & str )

Definition at line 75 of file Journal.cpp.

{
   return str.ToStdString();
}

References str.

◆ VersionCheck()

bool Journal::anonymous_namespace{Journal.cpp}::VersionCheck ( const wxString & value )

True if value is an acceptable journal version number to be rerun.

Definition at line 168 of file Journal.cpp.

{
   auto strings = wxSplit( value, '.' );
   std::vector<int> numbers;
   for ( auto &string : strings ) {
      long value;
      if ( !string.ToCLong( &value ) )
         return false;
      numbers.push_back( value );
   }
   // OK if the static version number is not less than the given value
   // Maybe in the future there will be a compatibility break
   return !std::lexicographical_compare(
      std::begin( journalVersionNumbers ), std::end( journalVersionNumbers ),
      numbers.begin(), numbers.end() );
}

References details::begin(), details::end(), and journalVersionNumbers.

Referenced by Journal::Begin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VersionString()

wxString Journal::anonymous_namespace{Journal.cpp}::VersionString ( )

Definition at line 157 of file Journal.cpp.

{
   wxString result;
   for ( auto number : journalVersionNumbers ) {
      auto str = wxString::Format( "%d", number );
      result += ( result.empty() ? str : ( '.' + str ) );
   }
   return result;
}