PEBLUtility.h

Go to the documentation of this file.

//* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       utility/PEBLUtility.h
//    Purpose:    Miscellaneous Utility Functions used in PEBL
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    PEBL is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PEBLUTILITY_H__
#define __PEBLUTILITY_H__
 
 
#include "../devices/PKeyboard.h"
//#include "../apps/Globals.h"
#include "Defs.h"
#include <string>
 
 
#define JSMN_HEADER
#include "jsmn.h"
 
 
#ifdef PEBL_WINDOWS
#include <windows.h>
typedef struct PROCESS_INFORMATION;
 
#endif
 
class Variant;
enum PEBLVideoMode: unsigned int;
enum PEBLVideoDepth: unsigned int;
namespace PEBLUtility
{
 
 
    std::string ToUpper(const std::string & text);
    std::string ToLower(const std::string & text);
 
 
    pDouble StringToPDouble(const char * mystring);
 
    pDouble Log2(pDouble val);
    pInt Round(pDouble val);
    pDouble Round(pDouble val, pInt prec);
    pInt Truncate(pDouble val);
 
    Variant Tokenize(const char* line, char separator);
 
 
    PEBL_Keycode TranslateString(const std::string & letters);
    //    PEBLKey TranslateStringOLD(const std::string & let)
 
    //    std::string TranslateKeyCode(const PEBLKey key, int modkeys);
    std::string TranslateKeycode(const PEBL_Keycode key, int modkeys);
 
    // Pre-initialize keycode lookup tables to avoid lazy-init delay on first keypress
    // Call this during environment initialization to prevent timing measurement artifacts
    void InitializeKeycodeLookups();
 
 
 
    pDouble RandomUniform();
    pDouble RandomNormal();
 
    std::string ShiftSwitch(int modkeys, std::string lower, std::string upper);
 
    PEBLVideoMode GetVideoMode(std::string modeline);
    PEBLVideoDepth GetVideoDepth(std::string depthline);
 
 
    Variant GetDirectoryListing(std::string path);
    Variant IsDirectory(std::string path);
    Variant FileExists(std::string path);
    Variant MakeDirectory(std::string path);
    Variant DeleteMyFile(std::string path);
    Variant GetHomeDirectory();
    Variant GetWorkingDirectory();
    Variant SetWorkingDirectory(std::string path);
 
    const std::string  StripFile(const std::string &  file);
    const std::string GetBaseFileName(const std::string &  file);
    Variant LaunchFile(std::string file);
    Variant SystemCall(std::string path, std::string args);
#ifdef PEBL_WINDOWS
    PROCESS_INFORMATION SystemCallAndReturn(std::string path, std::string args);
#endif
    bool is_utf8(const std::string str);
    void strrev(char*p);
    void strrev_utf8(char*p);
    std::string strrev(std::string p);
    std::string strrev_utf8(std::string p);
 
 
    std::string MD5File(const std::string & filename);
    std::string MD5String(const std::string & text);
 
    void CopyToClipboard(const std::string & text);
    Variant ExtractJSONObject(const std::string & text,
                              int remaining,
                              jsmntok_t **t, int start, int end);
 
    Variant ParseJSON(const std::string &text);
 
    // Unicode script detection functions
    // Returns ISO 15924 4-letter script code (e.g., "Arab", "Hebr", "Hani", "Thai")
    // Returns NULL/empty string for Latin/unknown scripts
    std::string DetectScript(const std::string & text);
 
    // Returns true if the script code is right-to-left (Arabic, Hebrew)
    bool IsRTLScript(const std::string & script);
 
    // Font selection based on language code (2-letter ISO 639-1) or script code (4-letter ISO 15924)
    // Returns appropriate font filename for the given language/script
    // fontType: 0=sans-serif, 1=monospace, 2=serif
    std::string GetFontForLanguageOrScript(const std::string & code, int fontType);
 
    // Property chain resolution for nested property access (e.g., obj.prop1.prop2)
    // Recursively traverses the property chain and returns the final value
    Variant ResolvePropertyChain(Variant obj, const std::string& propertyChain);
 
    // Property chain assignment for nested property access (e.g., obj.prop1.prop2 <- value)
    // Recursively traverses to the parent object and sets the final property
    void SetPropertyChain(Variant obj, const std::string& propertyChain, Variant value);
 
 
}
 
 
#endif