Služba ScriptForge.String

Služba String nabízí sadu metod na zpracování řetězců. Pomocí těchto metod je možné:

• Validovat obsah řetězců.

• Formátovat řetězce ořezáváním, zarovnáním nebo zalamováním jejich obsahu.

• Používat regulární výrazy pro vyhledávání a nahrazování podřetězců.

• Používat na řetězce hashovací algoritmy atd.

Definice

Zalomení řádku

Služba String rozpoznává následující zalomení řádku:

Prázdné znaky

Služba String rozpoznává následující prázdné znaky:

Escape sekvence

Následuje seznam escape sekvencí, které lze v řetězcích použít.

Chcete-li, aby se escape sekvence "\n" interpretovala jako skutečný řetězec, jednoduše použijte "\\n" místo "\" & Chr(10).

Netisknutelné znaky:

Za netisknutelné se považují znaky definované v databázi znaků Unicode (Unicode Character Database) jako „Other“ nebo „Separator“.

Za netisknutelné se považují také řídicí znaky (kód ASCII <= 0x1F).

Uvozovky v řetězcích:

Uvozovky přidáte do řetězců pomocí \' (jednoduchá uvozovka) nebo \" (dvojitá uvozovka). Například:

• Řetězec [str\'i\'ng] je interpretován jako [str'i'ng]

• Řetězec [str\"i\"ng] je interpretován jako [str"i"ng]

Volání služby

Před používáním služby ScriptForge.String je nutné načíst knihovnu ScriptForge pomocí:

      GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
  

Načtení knihovny vytvoří objekt SF_String, který lze používat pro volání metod služby String.

Následující části kódu ukazují různé způsoby volání metod služby String (jako příklad je uvedena metoda Capitalize):

    Dim s as String : s = "abc def"
    s = SF_String.Capitalize(s) ' Abc Def
  

    Dim s as String : s = "abc def"
    Dim svc : svc = SF_String
    s = svc.Capitalize(s) ' Abc Def
  

    Dim s as String : s = "abc def"
    Dim svc : svc = CreateScriptService("String")
    s = svc.Capitalize(s) ' Abc Def
  

Níže uvedená část kódu ukazuje, jak volat metody služby String ze skriptů Pythonu. Jako příklad je použita metoda IsIPv4.

    from scriptforge import CreateScriptService
    svc = CreateScriptService("String")
    ip_address = '192.168.0.14'
    svc.IsIPv4(ip_address) # True
  

Vlastnosti

Objekt SF_String poskytuje skriptům Basicu následující vlastnosti:

Výše uvedené vlastnosti může použít pro identifikaci nebo vkládání odpovídajících znaků do řetězců. Například line feed lze nahradit vlastností SF_String.sfLF.

Prvním argumentem je u většiny metod zpracovávaný řetězec. Vždy se předává odkazem, a zůstává tedy nezměněn. Metody jako Capitalize či Escape vrací po provedení nový řetězec.

Protože v Pythonu je již obsáhlá podpora pro řetězce vestavěná, většina metod služby String je k dispozici pouze pro skripty Basicu. Metodami dostupnými v Basicu i Pythonu jsou: HashStr, IsADate, IsEmail, IsFileName, IsIBAN, IsIPv4, IsLike, IsSheetName, IsUrl, SplitNotQuoted a Wrap.

Capitalize

Změní první písmeno každého slova vstupního řetězce na velké.

svc.Capitalize(inputstr: str): str

inputstr: Řetězec, u nějž se mají první písmena změnit.

    Dim sName as String : sName = "john smith"
    Dim sCapitalizedName as String
    sCapitalizedName = SF_String.Capitalize(sName)
    MsgBox sCapitalizedName 'John Smith
  

Count

Zjistí pro řetězec počet výskytů podřetězce nebo regulárního výrazu.

svc.Count(inputstr: str, substring: str, [isregex: bool], [casesensitive: bool]): int

inputstr: Vstupní řetězec, pro nějž se má počet zjistit.

substring: Podřetězec nebo regulární výraz použitý pro vyhledávání.

isregex: Použijte True, pokud je podřetězec regulárním výrazem (výchozí = False)

casesensitive: Zda se u vyhledávání rozlišuje velikost písmen (výchozí = False).

    ' Spočítá výskytu podřetězce "or" ve vstupním řetězci (vrátí 2)
    MsgBox SF_String.Count("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "or", CaseSensitive := False)
    ' Spočítá slova psaná pouze malými písmeny (vrátí 7)
    MsgBox SF_String.Count("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "\b[a-z]+\b", IsRegex := True, CaseSensitive := True)
  

Podrobnosti o regulárních výrazem naleznete v dokumentaci Pythonu na stránce Regular Expression Operations.

EndsWith

Vrátí True, pokud řetězec končí zadaným podřetězcem.

Funkce vrátí False také tehdy, má-li řetězec nebo podřetězec délku 0 nebo je-li podřetězec delší než řetězec.

svc.EndsWith(inputstr: str, substring: str, [casesensitive: bool]): bool

inputstr: Řetězec, který se má ověřit.

substring: Podřetězec, který se má vyhledat na konci řetězce inputstr.

casesensitive: Zda se u vyhledávání rozlišuje velikost písmen (výchozí = False).

    ' Vrátí True, protože metoda byla zavolána s výchozím parametrem casesensitive = False
    MsgBox SF_String.EndsWith("abcdefg", "EFG")
    ' Vzhledem k parametru casesensitive vrátí False
    MsgBox SF_String.EndsWith("abcdefg", "EFG", CaseSensitive := True)
  

Escape

Převede konce řádků a tabulátor ze vstupního řetězce na odpovídající escape sekvence (\\, \n, \r, \t).

svc.Escape(inputstr: str): str

inputstr: Řetězec, který se má převést.

    ' Vrátí řetězec "abc\n\tdef\\n"
    MsgBox SF_String.Escape("abc" & Chr(10) & Chr(9) & "def\n")
  

ExpandTabs

Nahradí znaky tabulátoru Chr(9) znaky mezery tak, aby byl napodoben krok tabulátoru.

Při zalomení řádku se začne vytvářet nový řádek a vynuluje se čítač znaků.

svc.ExpandTabs(inputstr: str, [tabsize: int]): str

inputstr: Vstupní řetězec, který se má upravit.

tabsize: Tento parametr odpovídající kroku tabulátoru se použije pro určení umístění textu, a to podle vzorců: tabsize + 1, 2 * tabsize + 1 , ... N * tabsize + 1 (výchozí = 8)

    Dim myText as String
    myText = "100" & SF_String.sfTAB & "200" & SF_String.sfTAB & "300" & SF_String.sfNEWLINE & _
             "X"  & SF_String.sfTAB & "Y" & SF_String.sfTAB & "Z"
    MsgBox SF_String.ExpandTabs(myText)
    '100     200     300
    'X       Y       Z
  

FilterNotPrintable

Nahradí všechny netisknutelné znaky vstupního řetězce zadaným znakem.

svc.FilterNotPrintable(inputstr: str, [replacedby: str]): str

inputstr: Řetězec, který se má prohledat.

replacedby: Žádný, jeden či více znaků, které nahradí každý netisknutelný znak v řetězci inputstr (výchozí = "").

    Dim LF : LF = Chr(10)
    Dim myText as String
    myText = "àén ΣlPµ" & LF & " Русский" & "\n"
    MsgBox SF_String.FilterNotPrintable(myText)
    ' "àén ΣlPµ Русский\n"
  

FindRegex

Najde v řetězci podřetězec odpovídající zadanému regulárnímu výrazu.

svc.FindRegex(inputstr: str, regex: str, [start: int], [casesensitive: bool], [forward: bool]): str

inputstr: Řetězec, který se má prohledat.

regex: Regulární výraz.

start: Pozice v řetězci, od níž vyhledávání začne. Tento parametr se předává odkazem, po provedení metody tedy bude hodnota start odkazovat na první znak nalezeného řetězce. Nebude-li nalezen žádný, hodnota start bude 0.

casesensitive: Zda se u vyhledávání rozlišuje velikost písmen (výchozí = False).

forward: Určuje směr vyhledávání. V případě True vyhledávání postupuje směrem dopředu, v opačném případě směrem zpět (výchozí = True).

Po první iteraci vyhledávání by měla být v případě forward = True hodnota start rovna 1, zatímco v případě forward = False by se tato hodnota měla rovnat Len(inputstr).

    Dim lStart As Long : lStart = 1
    Dim result as String
    result = SF_String.FindRegex("abCcdefghHij", "C.*H", lStart, CaseSensitive := True)
    MsgBox lStart & ": " & result
    '3: CcdefghH
  

Ve výše uvedeném příkladu je možné využít novou hodnotu lStart k tomu, aby vyhledávání pokračovalo. K tomu je nutné natavit pro další iteraci parametr start na hodnotu lStart + Len(result).

HashStr

Hashovací funkce se používají u některých kryptografických algoritmů, elektronických podpisů, autentizačních kódů, detekování podvodů, otisků (fingerprints), kontrolních součtů (kontrolách integrity zpráv), hashovacích tabulek, ukládání hesel apod.

Metoda HashStr vrátí výsledek hashovací funkce použité s daným algoritmem na zadaný řetězec. Návratovou hodnotou je řetězec složený z malých šestnáctkových číslic.

Podporovanými hashovacími algoritmy jsou: MD5, SHA1, SHA224, SHA256, SHA384 a SHA512.

svc.HashStr(inputstr: str, algorithm: str): str

inputstr: Řetězec, který má být zahashován. Předpokládá se, že je v kódování UTF-8. V hashovacím algoritmu bude řetězec považován za posloupnost bajtů.

algorithm: Některý z výše uvedených podporovaných algoritmů, zadaný jako řetězec.

    MsgBox SF_String.HashStr("œ∑¡™£¢∞§¶•ªº–≠œ∑´®†¥¨ˆøπ‘åß∂ƒ©˙∆˚¬", "MD5")
    ' c740ccc2e201df4b2e2b4aa086f35d8a
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    a_string = "œ∑¡™£¢∞§¶•ªº–≠œ∑´®†¥¨ˆøπ‘åß∂ƒ©˙∆˚¬"
    hash_value = svc.HashStr(a_string, "MD5")
    bas.MsgBox(hash_value)
    # c740ccc2e201df4b2e2b4aa086f35d8a
  

HtmlEncode

Zakóduje vstupní řetězec na HTML kódy znaků tím, že nahradí speciální znaky jim odpovídajícími řetězci, které začínají znakem &.

Například znak é bude nahrazen řetězcem &eacute; nebo odpovídajícím číselným HTML kódem.

svc.HtmlEncode(inputstr: str): str

inputstr: Řetězec, který se má zakódovat.

    MsgBox SF_String.HtmlEncode("<a href=""https://a.b.com"">From α to ω</a>")
    ' "&lt;a href=&quot;https://a.b.com&quot;&gt;From &#945; to &#969;&lt;/a&gt;"
  

IsADate

Vrátí True, pokud vstupní řetězec představuje pro určený formát platné datum.

svc.IsADate(inputstr: str, [dateformat: str]): bool

inputstr: Řetězec, který se má ověřit. Je-li prázdný, metoda vrátí False.

dateformat: Formát data jako řetězec. Je možné zvolit "YYYY-MM-DD" (výchozí), "DD-MM-YYYY" nebo "MM-DD-YYYY".

Spojovník (-) lze nahradit tečkou (.), lomítkem (/) nebo mezerou.

V případě neplatného formátu metoda vrátí False.

    MsgBox SF_String.IsADate("2020-12-31", "YYYY-MM-DD") ' True
  

Tato metoda kontroluje pouze formát vstupního řetězce, nekontroluje, zda odpovídá datu kalendáře. Neověřuje tedy vstupní řetězec vzhledem k přestupným rokům či tomu, zda má měsíc 30 nebo 31 dní. Pro takovou kontrolu je určena vestavěná funkce IsDate.

Níže uvedený příklad ukazuje rozdíl mezi metodou IsADate (ScriptForge) a funkcí IsDate (vestavěná).

    Dim myDate as String : myDate = "2020-02-30"
    MsgBox SF_String.IsADate(myDate, "YYYY-MM-DD") 'True
    MsgBox IsDate(myDate) ' False
  

    svc = CreateScriptService("String")
    s_date = "2020-12-31"
    result = svc.IsADate(s_date) # True
  

IsAlpha

Vrátí True, jsou-li všechny znaky řetězce písmeny abecedy.

Znaky abecedy jsou ty znaky, které jsou v databázi znaků Unicode (Unicode Character Database) definovány jako Letter.

svc.IsAlpha(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsAlpha("àénΣlPµ") ' True
    MsgBox SF_String.IsAlpha("myVar3") ' False
  

IsAlphaNum

Vrátí True, jestliže jsou všechny znaky řetězce písmena abeceda, číslice nebo "_" (podtržítka). První znak nesmí být číslice.

svc.IsAlphaNum(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsAlphaNum("_ABC_123456_abcàénΣlPµ") ' True
    MsgBox SF_String.IsAlphaNum("123ABC") ' False
  

IsAscii

Vrátí True, jsou-li všechny znaky řetězce znaky ASCII.

svc.IsAscii(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsAscii("a%?,25") ' True
    MsgBox SF_String.IsAscii("abcàénΣlPµ") ' False
  

IsDigit

Vrátí True, jsou-li všechny znaky řetězce číslicemi.

svc.IsDigit(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsDigit("123456") ' True
    MsgBox SF_String.IsDigit("_12a") ' False
  

IsEmail

Vrátí True, jestliže řetězec představuje platnou e-mailovou adresu.

svc.IsEmail(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsEmail("first.last@something.org") ' True
    MsgBox SF_String.IsEmail("first.last@something.com.br") ' True
    MsgBox SF_String.IsEmail("first.last@something.123") ' False
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    bas.MsgBox(svc.IsEmail("first.last@something.org")) # True
    bas.MsgBox(svc.IsEmail("first.last@something.com.br")) # True
    bas.MsgBox(svc.IsEmail("first.last@something.123")) # False
  

IsFileName

Vrátí True, jestliže řetězec představuje v zadaném operačním systému platný název souboru.

svc.IsFileName(inputstr: str, [osname: str]): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

osname: Název operačního systému jako řetězec. Může se jednat o hodnoty "WINDOWS", "LINUX", "MACOSX" a "SOLARIS".

Výchozí hodnotou je operační systém, na kterém je skript spuštěn.

    MsgBox SF_String.IsFileName("/home/user/Documents/a file name.odt", "LINUX") ' True
    MsgBox SF_String.IsFileName("C:\home\a file name.odt", "LINUX") ' False
    MsgBox SF_String.IsFileName("C:\home\a file name.odt", "WINDOWS") ' True
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    bas.MsgBox(svc.IsFileName("/home/user/Documents/a file name.odt", "LINUX")) # True
    bas.MsgBox(svc.IsFileName(r"C:\home\a file name.odt", "LINUX")) # False
    bas.MsgBox(svc.IsFileName(r"C:\home\a file name.odt", "WINDOWS")) # True
  

IsHexDigit

Vrátí True, jsou-li všechny znaky řetězce šestnáctkovými číslicemi.

svc.IsHexDigit(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

Šestnáctkové číslice mohou být uvozeny znaky "0x" nebo "&H".

    MsgBox SF_String.IsHexDigit("&H00FF") ' True
    MsgBox SF_String.IsHexDigit("08AAFF10") ' True
    MsgBox SF_String.IsHexDigit("0x18LA22") ' False
  

IsIBAN

Vrátí True, jestliže řetězec představuje platné Mezinárodní číslo bankovního účtu (International Bank Account Number, IBAN). Při porovnávání se nerozlišuje velikost písmen.

svc.IsIBAN(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

True, pokud řetězec obsahuje platné číslo IBAN.

    ' Basic
    MsgBox SF_String.IsIBAN("BR15 0000 0000 0000 1093 2840 814 P2") ' True
  

    # Python
    result = svc.IsIBAN("BR15 0000 0000 0000 1093 2840 814 P2") # True
  

IsIPv4

Vrátí True, jestliže řetězec představuje platnou IP adresu (v4).

svc.IsIPv4(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsIPv4("192.168.1.50") ' True
    MsgBox SF_String.IsIPv4("192.168.50") ' False
    MsgBox SF_String.IsIPv4("255.255.255.256") ' False
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    bas.MsgBox(svc.IsIPv4("192.168.1.50")) # True
    bas.MsgBox(svc.IsIPv4("192.168.50")) # False
    bas.MsgBox(svc.IsIPv4("255.255.255.256")) # False
  

IsLike

Vrátí True, jestliže celý vstupní řetězec odpovídá zadanému vzorku obsahujícímu zástupné znaky.

svc.IsLike(inputstr: str, pattern: str, [casesensitive: bool]): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

pattern: Vzorek jako řetězec. Zástupnými znaky jsou:

• "?" představuje libovolný jediný znak;

• "*" představuje žádný, jeden či více znaků.

casesensitive: Zda se u vyhledávání rozlišuje velikost písmen (výchozí = False).

    MsgBox SF_String.IsLike("aAbB", "?A*") ' True
    MsgBox SF_String.IsLike("C:\a\b\c\f.odb", "?:*.*") ' True
    MsgBox SF_String.IsLike("name:host", "?*@?*") ' False
    MsgBox SF_String.IsLike("@host", "?*@?*") ' False
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    bas.MsgBox(svc.IsLike("aAbB", "?A*")) # True
    bas.MsgBox(svc.IsLike(r"C:\a\b\c\f.odb", "?:*.*")) # True
    bas.MsgBox(svc.IsLike("name:host", "?*@?*")) # False
    bas.MsgBox(svc.IsLike("@host", "?*@?*")) # False
  

IsLower

Vrátí True, jsou-li všechny znaky vstupního řetězce malými písmeny. Znaky, které nejsou písmeny abecedy, se ignorují.

svc.IsLower(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsLower("abc'(-xy4z") ' True
    MsgBox SF_String.IsLower("1234") ' True
    MsgBox SF_String.IsLower("abcDefg") ' False
  

IsPrintable

Vrátí True, jsou-li všechny znaky řetězce tisknutelné.

svc.IsPrintable(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsPrintable("àén ΣlPµ Русский") ' True
    MsgBox SF_String.IsPrintable("First line." & Chr(10) & "Second Line.") ' False
  

IsRegex

Vrátí True, jestliže celý vstupní řetězec odpovídá zadanému regulárnímu výrazu.

svc.IsRegex(inputstr: str, regex: str, [casesensitive: bool]): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

regex: Regulární výraz. Je-li prázdný, metoda vrátí False.

casesensitive: Zda se u vyhledávání rozlišuje velikost písmen (výchozí = False).

        MsgBox SF_String.IsRegex("aAbB", "[A-Za-z]+") ' True
        MsgBox SF_String.IsRegex("John;100", "[A-Za-z]+;[0-9]+") ' True
        MsgBox SF_String.IsRegex("John;100;150", "[A-Za-z]+;[0-9]+") ' False
      

IsSheetName

Vrátí True, jestliže vstupní řetězec představuje platný název listu Calcu.

svc.IsSheetName(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.

    MsgBox SF_String.IsSheetName("1àbc + ""déf""") ' True
    MsgBox SF_String.IsSheetName("[MySheet]") ' False
  

    svc = CreateScriptService("String")
    bas = CreateScriptService("Basic")
    bas.MsgBox(svc.IsSheetName("1àbc + ""déf""")) # True
    bas.MsgBox(svc.IsSheetName("[MySheet]")) # False
  

Název listu nemůže obsahovat znaky [ ] * ? : / \ nebo znak ' (apostrof) na první nebo poslední pozici.

IsTitle

Vrátí True, je-li první znak každého slova velké písmeno a ostatní znaky jsou malá písmena.

svc.IsTitle(inputstr: str): bool

inputstr: Řetězec, který se má zkontrolovat. Je-li prázdný, metoda vrátí False.