DXP.Util.h

Go to the documentation of this file.

#pragma once
 
#ifndef DXP_UTIL_H_INCLUDED
#define DXP_UTIL_H_INCLUDED
 
#include <sstream>
#include <string>
#include <vector>
 
#include "DXP.Types.h"
#include "DXP.Interfaces.h"
 
using namespace std;
using namespace DXP;
 
/*..................................................................................................*/
IClient * GetClientInterface();
/*..................................................................................................*/
 
/*..................................................................................................*/
bool ProcessKeyByClient(WORD keyID);
/*..................................................................................................*/
 
/*..................................................................................................*/
struct TFileOwnershipDetails
{
    std::wstring ComputerName;
    std::wstring UserName;
    std::wstring ProcessID;
};
/*..................................................................................................*/
 
/*..................................................................................................*/
bool FileOwnership_IsOwnedByOther           (const std::wstring & ADataFileName, std::wstring * AComputerName, std::wstring * AUserName);
bool FileOwnership_Details                  (const std::wstring & ADataFileName, TFileOwnershipDetails * ADetails);
 
void FileOwnership_WarnOwnedByOther         (const std::wstring & AFullFileName, const std::wstring & AComputerName, const std::wstring & AUserName, TFileOwnershipWarningLevel AFileOwnershipWarningLevel);
void FileOwnership_WarnOwnedByOther_Message (const std::wstring & AFullFileName, const std::wstring & AComputerName, const std::wstring & AUserName);
void FileOwnership_WarnOwnedByOther_Dialog  (const std::wstring & AFullFileName, const std::wstring & AComputerName, const std::wstring & AUserName);
void FileOwnership_ReportAcquisition_Message(const std::wstring & AFullFileName, const std::wstring & AComputerName, const std::wstring & AUserName);
 
bool OwnershipFileIsDangling(const std::wstring & ALockFileName);
void FileOwnership_CleanDanglingOwnershipFile(const std::wstring & ADataFileName);
 
HANDLE FileOwnership_RegisterAcquisition  (const std::wstring & ADataFileName);
HANDLE FileOwnership_UnRegisterAcquisition(const std::wstring & ADataFileName, HANDLE ALockFileHandleInteger);
std::wstring GetOwnershipFileName(const std::wstring & ADataFileName);
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring GetLocalComputerName();
std::wstring GetLocalUserName();
std::wstring GetCurrentProcessIdString();
std::wstring GetCurrentProductName();
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring ExtractFilePath(const std::wstring & FileName);
std::wstring ExtractFileDir (const std::wstring & FileName);
std::wstring ExtractFileName(const std::wstring & FileName);
std::wstring ExtractFileExt (const std::wstring &FileName);
std::wstring ChangeFileExt(const std::wstring & FileName, const std::wstring & Extension);
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring AddSlash(const std::wstring & Str, const WCHAR ASlash = L'\\');
/*..................................................................................................*/
 
/*..................................................................................................*/
void ShowWarning            (const std::wstring & Text, const std::wstring & Caption = L"");
void ShowInfo               (const std::wstring & Text, const std::wstring & Caption = L"");
void ShowError              (const std::wstring & Text, const std::wstring & Caption = L"");
void ShowMessage            (const std::wstring & Text);
bool ConfirmOKCancel        (const std::wstring & Text);
bool ConfirmNoYes           (const std::wstring & Text);
int  ConfirmNoYesCancel     (const std::wstring & Text);
bool ConfirmNoYesWithCaption(const std::wstring & Caption, const std::wstring & Text);
/*..................................................................................................*/
 
/*..................................................................................................*/
bool   FileExists(const std::wstring & FileName);
HANDLE FileOpen  (const std::wstring & FileName, unsigned int Mode);
void   FileClose (HANDLE handle);
/*..................................................................................................*/
 
/*..................................................................................................*/
IOptionsReader* ServerOptionsReader(const std::wstring & serverName);
IOptionsWriter* ServerOptionsWriter(const std::wstring & serverName);
/*..................................................................................................*/
 
/*..................................................................................................*/
wstring GetTime();
double Now();
double EncodeDate(WORD Year, WORD Month, WORD Day);
double EncodeTime(WORD Hour, WORD Min, WORD Sec, WORD MSec);
/*..................................................................................................*/
 
/*..................................................................................................*/
class WStringVector : public std::vector<std::wstring>
{
public:
    bool CaseSensitive;
 
    bool LoadFromFile(const std::wstring & FileName);
    bool SaveToFile  (const std::wstring & FileName);
    void Sort();
 
    WStringVector(bool ACaseSensitive = true) : CaseSensitive(ACaseSensitive) {}
};
/*..................................................................................................*/
 
/*..................................................................................................*/
class CSensitiveCompare
{
public:
    bool operator() (const wstring& a, const wstring& b) const
    {
        return wcscmp(a.c_str(), b.c_str()) < 0;
    }
};
/*..................................................................................................*/
 
/*..................................................................................................*/
class CInsensitiveCompare
{
public:
    bool operator() (const wstring& a, const wstring& b) const
    {
        return _wcsicmp(a.c_str(), b.c_str()) < 0;
    }
};
/*..................................................................................................*/
 
/*..................................................................................................*/
bool IsAltiumViewer();
IClientAPI_Interface * ClientAPI();
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring SpecialFolder_MyDesigns();
/*..................................................................................................*/
 
/*..................................................................................................*/
void RunCommand (const std::wstring & IdString, std::wstring SpecialParameter);
void RunCommand (const std::wstring & IdString, std::wstring SpecialParameter, IServerDocumentView * const DocumentView);
/*..................................................................................................*/
 
/*..................................................................................................*/
void MessageRouter_SendCommandToModule(const wstring & AProcess, wstring * AParameters, IServerDocumentView * const DocumentView);
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring & LTrim(std::wstring & s); // trim from start
std::wstring & RTrim(std::wstring & s); // trim from end
std::wstring &  Trim(std::wstring & s); // trim from both ends
 
std::wstring & UpperCase(std::wstring & s);
 
std::wstring   StringReplace(const std::wstring & S, const std::wstring & OldPattern, const std::wstring & NewPattern, bool ReplaceAll = true, bool IgnoreCase = false);
 
vector<wstring> &Split(const wstring &s, wchar_t delim, vector<wstring> &elems);
vector<wstring>  Split(const wstring &s, wchar_t delim);
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring ToWString(float  val);
std::wstring ToWString(double val);
 
template <typename T> std::wstring ToWString(T val)
{
    std::wstringstream ss;
    ss<<val;
    return std::wstring(ss.str());
}
/*..................................................................................................*/
 
/*..................................................................................................*/
std::wstring GetTemporaryFileName();
std::wstring GetTemporaryFileName(const std::wstring & BaseFolder);
/*..................................................................................................*/
 
/*..................................................................................................*/
bool GetString_PrefixAndIndex(const std::wstring & Str, const std::wstring & Prefix, int * Index);
/*..................................................................................................*/
 
/*..................................................................................................*/
bool  StringStartsWithButNotEqual(const std::wstring & AString, const std::wstring & SubString);
/*..................................................................................................*/
 
/*..................................................................................................*/
void StatusBar_SetState(int Index, const std::wstring & S);
std::wstring StatusBar_GetState(int Index);
void StatusBar_SetStateDefault();
void StatusBar_PushStatus();
void StatusBar_PopStatus();
/*..................................................................................................*/
 
/*..................................................................................................*/
//normal progress in status bar, normal progress in Win7 taskbar button
void Percent_Init(const std::wstring & InitialString,  int TotalCount);
void Percent_Finish();
void Percent_UpdateByNumber(int AmountToIncrement);
void Percent_Update();
 
//marquee progress in status bar, marquee progress in Win7 taskbar button
void Percent_BeginUndeterminedOperation(const std::wstring & InitialString);
void Percent_EndUndeterminedOperation();
 
//status bar - N/A, marquee progress in Win7 taskbar button
void Percent_BeginComplexOperation(const std::wstring & InitialString);
void Percent_EndComplexOperation();
/*..................................................................................................*/
 
/*..................................................................................................*/
IServerDocument * CreateNewDocumentFromDocumentKind(const std::wstring & DocumentKind);
/*..................................................................................................*/
 
/*..................................................................................................*/
double round(double num);
/*..................................................................................................*/
 
/*..................................................................................................*/
double CoordToMils(int C);
double CoordToMMs (int C);
 
int    MilsToCoord    (double M);
double MilsToRealCoord(double M);
int    MMsToCoord     (double M);
double MMsToRealCoord (double M);
/*..................................................................................................*/
 
/*..................................................................................................*/
double DegreesToRadians(double Angle);
double RadiansToDegrees(double R);
/*..................................................................................................*/
 
#endif  // DXP_UTIL_H_INCLUDED