diaginit.cpp

Go to the documentation of this file.

//----------------------------------------------------------------------------
// ObjectWindows
// Copyright (c) 1993, 1996 by Borland International, All Rights Reserved
//
/// \file
/// Implementation of diagnostic initialization functions. Settings are stored
/// in a profile (name is provided) in a section named "Diagnostics". Profile
/// format in an ascii .ini file looks like:
/// \code
///  [Diagnostics]
///  Enabled = <enabled>
///  <groupname1> = <enabled> <level>
///  <groupname2> = <enabled> <level>
///    ...
///  <groupnameN> = <enabled> <level>
/// \endcode
/// where:
/// \code
///  <enabled> = 0|1
///  <level>   = 0..255
/// \endcode
//----------------------------------------------------------------------------
#include <owl/pch.h>
#include <owl/defs.h>
#include <owl/profile.h>
#include <owl/shellitm.h>
#include <filesystem>
 
using namespace std;
using namespace std::filesystem;
 
namespace owl {
 
namespace
{
 
  const tchar DiagnosticsSection[] = _T("Diagnostics");
 
  struct TGroupSettings
  {
    int Enabled;
    int Level;
 
    // Parses the settings for the given group in the given profile.
    // The format of the setting is "<int Enabled> <int Level>", e.g. "1 3".
    // If no setting is found, or parsing fails, the given defaults are used.
    //
    TGroupSettings(TProfile& p, const tstring& group, int defEnabled, int defLevel = 0)
      : Enabled(defEnabled), Level(defLevel)
    {
      tistringstream is(p.GetString(group));
      is >> Enabled >> Level;
    }
  };
 
  auto GetRoamingAppDataFolderPath_() -> path
  {
    // NOTE: pszPath should be freed by CoTaskMemFree, whether SHGetKnownFolderPath succeeds or not.
    // See: https://learn.microsoft.com/en-gb/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath
    //
    auto pszPath = PWSTR{};
    const auto r = SHGetKnownFolderPath(FOLDERID_RoamingAppData, KF_FLAG_DONT_VERIFY, nullptr, &pszPath);
    const auto pathGuard = unique_ptr<WCHAR, decltype(&CoTaskMemFree)>{pszPath, &CoTaskMemFree};
    if (r != S_OK) throw TXOwl{_T("SHGetKnownFolderPath failed")};
    CHECK(pszPath);
    return pszPath;
  };
 
} // namespace
 
//
// Returns the full path for the given file.
// If the given file has no parent path, the parent path is assumed to be "%appdata%\OWLNext".
// This is a private function. However, it is defined in the `owl` namespace, since it is reused
// internally by TTraceWindow in "tracewnd.cpp".
//
auto GetDiagIniFullFileName_(LPCSTR filename) -> tstring
{
  const auto f = path{filename};
  if (f.has_parent_path())
    return to_tstring(f);
 
  const auto d = GetRoamingAppDataFolderPath_() / _T("OWLNext");
  if (!exists(d))
    create_directory(d);
  return to_tstring(d / f);
}
 
_OWLFUNC(bool)
GetDiagEnabled(LPCSTR filename, LPCSTR diagGroup, bool defEnabled)
{
  _USES_CONVERSION;
  TProfile p(DiagnosticsSection, GetDiagIniFullFileName_(filename));
 
  bool globallyEnabled = p.GetInt(_T("Enabled"), 1) != 0;
  if (!globallyEnabled) return false;
 
  TGroupSettings s(p, _A2W(diagGroup), defEnabled ? 1 : 0);
  return s.Enabled != 0;
}
 
_OWLFUNC(int)
GetDiagLevel(LPCSTR filename, LPCSTR diagGroup, int defLevel)
{
  _USES_CONVERSION;
  TProfile p(DiagnosticsSection, GetDiagIniFullFileName_(filename));
  TGroupSettings s(p, _A2W(diagGroup), 0, defLevel);
  return s.Level;
}
 
} // OWL namespace