### extends 'class_empty.py'
### block ClassImports
# NOTICE: Do not edit anything here, it is generated code
from . import gxapi_cy
from geosoft.gxapi import GXContext, float_ref, int_ref, str_ref
### endblock ClassImports
### block Header
# NOTICE: The code generator will not replace the code in this block
### endblock Header
### block ClassImplementation
# NOTICE: Do not edit anything here, it is generated code
[docs]class GXSTR(gxapi_cy.WrapSTR):
"""
GXSTR class.
This library is not a class. Use the `GXSTR <geosoft.gxapi.GXSTR>` library functions
to work with and manipulate string variables. Since the
GX Programming Language does not provide string literal
tokens, you must use these functions for any string operations
you want to perform.
"""
[docs] def __init__(self, handle=0):
super(GXSTR, self).__init__(GXContext._get_tls_geo(), handle)
[docs] @classmethod
def null(cls):
"""
A null (undefined) instance of `GXSTR <geosoft.gxapi.GXSTR>`
:returns: A null `GXSTR <geosoft.gxapi.GXSTR>`
:rtype: GXSTR
"""
return GXSTR()
[docs] def is_null(self):
"""
Check if this is a null (undefined) instance
:returns: True if this is a null (undefined) instance, False otherwise.
:rtype: bool
"""
return self._internal_handle() == 0
# Data Input
[docs] @classmethod
def scan_i(cls, str_val):
"""
Convert a string to a GX int.
:param str_val: String to convert to an integer
:type str_val: str
:returns: Resulting Integer, `iDUMMY <geosoft.gxapi.iDUMMY>` is bad integer
:rtype: int
.. versionadded:: 6.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._scan_i(GXContext._get_tls_geo(), str_val.encode())
return ret_val
[docs] @classmethod
def scan_date(cls, str_val, type):
"""
Convert a date string to a GX real.
:param str_val: Date string
:param type: :ref:`DATE_FORMAT`
:type str_val: str
:type type: int
:returns: Resulting Real, `rDUMMY <geosoft.gxapi.rDUMMY>` if conversion fails.
:rtype: float
.. versionadded:: 6.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** OLD usage, use ScanForm_STR instead.
"""
ret_val = gxapi_cy.WrapSTR._scan_date(GXContext._get_tls_geo(), str_val.encode(), type)
return ret_val
[docs] @classmethod
def scan_r(cls, str_val):
"""
Convert a string to a GX real.
:param str_val: String to convert to a real
:type str_val: str
:returns: Resulting Real, `rDUMMY <geosoft.gxapi.rDUMMY>` if bad string.
:rtype: float
.. versionadded:: 6.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._scan_r(GXContext._get_tls_geo(), str_val.encode())
return ret_val
[docs] @classmethod
def scan_time(cls, str_val, type):
"""
Convert a time string to a GX real.
:param str_val: Date string
:param type: :ref:`TIME_FORMAT`
:type str_val: str
:type type: int
:returns: Resulting Real, `rDUMMY <geosoft.gxapi.rDUMMY>` if conversion fails.
:rtype: float
.. versionadded:: 6.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** OLD usage, use ScanForm_STR instead.
"""
ret_val = gxapi_cy.WrapSTR._scan_time(GXContext._get_tls_geo(), str_val.encode(), type)
return ret_val
# File Name
[docs] @classmethod
def file_combine_parts(cls, drive, dir, file, ext, qual, file_name):
"""
Combine file parts to build a file name.
:param drive: Drive
:param dir: Directory
:param file: Name
:param ext: Extension
:param qual: Qualifiers
:param file_name: Destination string, can be same as input
:type drive: str
:type dir: str
:type file: str
:type ext: str
:type qual: str
:type file_name: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
file_name.value = gxapi_cy.WrapSTR._file_combine_parts(GXContext._get_tls_geo(), drive.encode(), dir.encode(), file.encode(), ext.encode(), qual.encode(), file_name.value.encode())
[docs] @classmethod
def file_ext(cls, ifile, ext, ofile, opt):
"""
Add a file extension onto a file name string.
:param ifile: File name to extend
:param ext: Extension if "", extenstion and '.' are stripped.
:param ofile: Extended file name (can be same as input)
:param opt: :ref:`FILE_EXT`
:type ifile: str
:type ext: str
:type ofile: str_ref
:type opt: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ofile.value = gxapi_cy.WrapSTR._file_ext(GXContext._get_tls_geo(), ifile.encode(), ext.encode(), ofile.value.encode(), opt)
[docs] @classmethod
def file_name_part(cls, file, file_part, part):
"""
Get part of a file name.
:param file: File name
:param file_part: Destination string, can be same as input
:param part: :ref:`STR_FILE_PART`
:type file: str
:type file_part: str_ref
:type part: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
file_part.value = gxapi_cy.WrapSTR._file_name_part(GXContext._get_tls_geo(), file.encode(), file_part.value.encode(), part)
[docs] @classmethod
def get_m_file(cls, in_str, out_str, index):
"""
Get the indexed filepath from a multiple filepath string
:param in_str: Input multifile string
:param out_str: Output filepath string
:param index: Index of file
:type in_str: str
:type out_str: str_ref
:type index: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The multifile string must use '|' as a delimiter.
Do not pass a string after calling `tokenize <geosoft.gxapi.GXSTR.tokenize>`.
"""
out_str.value = gxapi_cy.WrapSTR._get_m_file(GXContext._get_tls_geo(), in_str.encode(), out_str.value.encode(), index)
[docs] @classmethod
def remove_qualifiers(cls, ifile, ofile):
"""
Remove file qualifiers from a file name
:param ifile: Input file name
:param ofile: Output file name (can be same as input)
:type ifile: str
:type ofile: str_ref
.. versionadded:: 7.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ofile.value = gxapi_cy.WrapSTR._remove_qualifiers(GXContext._get_tls_geo(), ifile.encode(), ofile.value.encode())
# Formating
# General
[docs] @classmethod
def escape(cls, str_val, opt):
"""
Convert/replace escape sequences in strings.
:param str_val: String to modify
:param opt: :ref:`STR_ESCAPE`
:type str_val: str_ref
:type opt: int
.. versionadded:: 5.0.6
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Escape characters:
\\a bell
\\b backspace
\\f formfeed
\\n new line
\\r carriage return
\\t tab
\\v vertical tab
\\" quote character
\\x take 'x' literally
\\ backslash
\\ooo octal up to 3 characters
\\xhh hex up to 2 characters
A common use of this function is to convert double-quote characters in
a user unput string to \\" so the string can be placed in a tokenized
string.
"""
str_val.value = gxapi_cy.WrapSTR._escape(GXContext._get_tls_geo(), str_val.value.encode(), opt)
[docs] @classmethod
def char_(cls, str_val):
"""
Returns the ASCII value of a character.
:param str_val: String to return ascii value of first character
:type str_val: str
:returns: ASCII value of first character in string.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._char_(GXContext._get_tls_geo(), str_val.encode())
return ret_val
[docs] @classmethod
def char_n(cls, str_val, c, max):
"""
Returns the ASCII value of the n'th character.
:param str_val: String
:param c: Character to get
:param max: Maximum string length (unused)
:type str_val: str
:type c: int
:type max: int
:returns: ASCII value of n'th character in string.
The first character is 0.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._char_n(GXContext._get_tls_geo(), str_val.encode(), c, max)
return ret_val
[docs] @classmethod
def justify(cls, in_str, out_str, width, just):
"""
Justify a string
:param in_str: String to justify
:param out_str: Result string, can be same as input
:param width: Justification width
:param just: :ref:`STR_JUSTIFY`
:type in_str: str
:type out_str: str_ref
:type width: int
:type just: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the string is too big to fit in the number of display characters,
the output string will be "**" justified as specified.
"""
out_str.value = gxapi_cy.WrapSTR._justify(GXContext._get_tls_geo(), in_str.encode(), out_str.value.encode(), width, just)
[docs] @classmethod
def replacei_match_string(cls, istr, old, new_str):
"""
Replaces all occurances of match string by replacement string with case insensitive.
:param istr: Destination String
:param old: Match string to replace
:param new_str: Replacement string
:type istr: str_ref
:type old: str
:type new_str: str
.. versionadded:: 7.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the replacement string is "" (NULL character)
then the string to replace is removed from the
input string, and the string is shortened.
"""
istr.value = gxapi_cy.WrapSTR._replacei_match_string(GXContext._get_tls_geo(), istr.value.encode(), old.encode(), new_str.encode())
[docs] @classmethod
def replace_match_string(cls, istr, old, new_str):
"""
Replaces all occurances of match string by replacement string with case sensitive.
:param istr: Destination String
:param old: Match string to replace
:param new_str: Replacement string
:type istr: str_ref
:type old: str
:type new_str: str
.. versionadded:: 7.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the replacement string is "" (NULL character)
then the string to replace is removed from the
input string, and the string is shortened.
"""
istr.value = gxapi_cy.WrapSTR._replace_match_string(GXContext._get_tls_geo(), istr.value.encode(), old.encode(), new_str.encode())
[docs] @classmethod
def set_char_n(cls, str_val, c, ascii):
"""
Set the n'th character of a string using an ASCII value
:param str_val: String
:param c: Character to set
:param ascii: ASCII value
:type str_val: str_ref
:type c: int
:type ascii: int
.. versionadded:: 5.1.4
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
str_val.value = gxapi_cy.WrapSTR._set_char_n(GXContext._get_tls_geo(), str_val.value.encode(), c, ascii)
[docs] @classmethod
def split_string(cls, origstr, ch, split):
"""
Splits a string in two on a character.
:param origstr: Original string
:param ch: Split character (first character of string)
:param split: Split string past split character.
:type origstr: str_ref
:type ch: str
:type split: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The original string is modified by terminating it
at the character split.
The part of the string past the character split is
copied to the split string.
Split characters in quoted strings are ignored.
This function is mainly intended to separate comments
from control file strings.
"""
origstr.value, split.value = gxapi_cy.WrapSTR._split_string(GXContext._get_tls_geo(), origstr.value.encode(), ch.encode(), split.value.encode())
[docs] @classmethod
def strcat(cls, dest, orig):
"""
This method contatinates a string.
:param dest: Destination String
:param orig: String to add
:type dest: str_ref
:type orig: str
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
dest.value = gxapi_cy.WrapSTR._strcat(GXContext._get_tls_geo(), dest.value.encode(), orig.encode())
[docs] @classmethod
def strcmp(cls, first, second, case_sensitive):
"""
This method compares two strings and returns these values
:param first: String A
:param second: String B
:param case_sensitive: :ref:`STR_CASE`
:type first: str
:type second: str
:type case_sensitive: int
:returns: A < B -1
A == B 0
A > B 1
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._strcmp(GXContext._get_tls_geo(), first.encode(), second.encode(), case_sensitive)
return ret_val
[docs] @classmethod
def strcpy(cls, dest, orig):
"""
This method copies a string into another string.
:param dest: Destination string
:param orig: Origin string
:type dest: str_ref
:type orig: str
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
dest.value = gxapi_cy.WrapSTR._strcpy(GXContext._get_tls_geo(), dest.value.encode(), orig.encode())
[docs] @classmethod
def stri_mask(cls, mask, test):
"""
Case insensitive comparison of two strings.
:param mask: Mask
:param test: String to test
:type mask: str
:type test: str
:returns: 0 if string does not match mask.
1 if string matches mask.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Mask characters '*' - matches any one or more up to
next character
'?' - matches one character
Test is case insensitive
"""
ret_val = gxapi_cy.WrapSTR._stri_mask(GXContext._get_tls_geo(), mask.encode(), test.encode())
return ret_val
[docs] @classmethod
def strins(cls, dest, ins, orig):
"""
This method inserts a string at a specified position.
:param dest: Destination String
:param ins: Insert Position
:param orig: String to add
:type dest: str_ref
:type ins: int
:type orig: str
.. versionadded:: 5.1.8
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the specified position does not fall within the current string
the source string will simply be Concatenated.
"""
dest.value = gxapi_cy.WrapSTR._strins(GXContext._get_tls_geo(), dest.value.encode(), ins, orig.encode())
[docs] @classmethod
def strlen(cls, str_val):
"""
Returns the length of a string.
:param str_val: String to find the length of
:type str_val: str
:returns: String length.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._strlen(GXContext._get_tls_geo(), str_val.encode())
return ret_val
[docs] @classmethod
def str_mask(cls, mask, test):
"""
Case sensitive comparison of two strings.
:param mask: Mask
:param test: String to test
:type mask: str
:type test: str
:returns: 0 if string does not match mask.
1 if string matches mask.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Mask characters '*' - matches any one or more up to
next character
'?' - matches one character
Test is case sensitive
"""
ret_val = gxapi_cy.WrapSTR._str_mask(GXContext._get_tls_geo(), mask.encode(), test.encode())
return ret_val
[docs] @classmethod
def str_min(cls, str_val):
"""
Remove spaces and tabs and return length
:param str_val: String to find the min length of
:type str_val: str_ref
:returns: String length.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** String may be modified. This function should not be
used to determine if a file name string is defined, because
a valid file name can contain spaces, and once "tested" the
name will be altered. Instead, use `str_min2 <geosoft.gxapi.GXSTR.str_min2>`, or use
`GXSYS.file_exist <geosoft.gxapi.GXSYS.file_exist>` to see if the file actually exists.
"""
ret_val, str_val.value = gxapi_cy.WrapSTR._str_min(GXContext._get_tls_geo(), str_val.value.encode())
return ret_val
[docs] @classmethod
def str_min2(cls, str_val):
"""
Length less spaces and tabs, string unchanged.
:param str_val: String to find the min length of
:type str_val: str
:returns: String length.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._str_min2(GXContext._get_tls_geo(), str_val.encode())
return ret_val
[docs] @classmethod
def strncmp(cls, first, second, n_char, case_sensitive):
"""
Compares two strings to a given number of characters.
:param first: String A
:param second: String B
:param n_char: Number of characters to compare
:param case_sensitive: :ref:`STR_CASE`
:type first: str
:type second: str
:type n_char: int
:type case_sensitive: int
:returns: A < B -1
A == B 0
A > B 1
:rtype: int
.. versionadded:: 5.0.5
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._strncmp(GXContext._get_tls_geo(), first.encode(), second.encode(), n_char, case_sensitive)
return ret_val
[docs] @classmethod
def str_str(cls, str_val, sub, case_sensitive):
"""
Scan a string for the occurrence of a given substring.
:param str_val: String to scan
:param sub: String to look for
:param case_sensitive: :ref:`STR_CASE`
:type str_val: str
:type sub: str
:type case_sensitive: int
:returns: -1 if the substring does not occur in the string
Index of first matching location if found
:rtype: int
.. versionadded:: 5.1.6
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapSTR._str_str(GXContext._get_tls_geo(), str_val.encode(), sub.encode(), case_sensitive)
return ret_val
[docs] @classmethod
def substr(cls, dest, orig, start, length):
"""
Extract part of a string.
:param dest: Destination string
:param orig: Origin string
:param start: Start location
:param length: Number of characters
:type dest: str_ref
:type orig: str
:type start: int
:type length: int
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The destination string length will be less than the
requested length if the substring is not fully enclosed
in the origin string.
"""
dest.value = gxapi_cy.WrapSTR._substr(GXContext._get_tls_geo(), dest.value.encode(), orig.encode(), start, length)
[docs] @classmethod
def to_lower(cls, str_val):
"""
Convert a string to lower case.
:param str_val: String
:type str_val: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
str_val.value = gxapi_cy.WrapSTR._to_lower(GXContext._get_tls_geo(), str_val.value.encode())
[docs] @classmethod
def to_upper(cls, str_val):
"""
Convert a string to upper case.
:param str_val: String
:type str_val: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
str_val.value = gxapi_cy.WrapSTR._to_upper(GXContext._get_tls_geo(), str_val.value.encode())
[docs] @classmethod
def xyz_line(cls, line, xyz):
"""
Make a valid XYZ line name from a valid `GXDB <geosoft.gxapi.GXDB>` line name.
:param line: Line name to convert
:param xyz: Buffer to hold new line name
:type line: str
:type xyz: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
xyz.value = gxapi_cy.WrapSTR._xyz_line(GXContext._get_tls_geo(), line.encode(), xyz.value.encode())
[docs] @classmethod
def make_alpha(cls, str_val):
"""
Turns all non alpha-numeric characters into an _.
:param str_val: String to trim
:type str_val: str_ref
.. versionadded:: 5.1.8
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** THE STRING IS MODIFIED.
"""
str_val.value = gxapi_cy.WrapSTR._make_alpha(GXContext._get_tls_geo(), str_val.value.encode())
[docs] @classmethod
def printf(cls, dest, mask):
"""
Variable Argument PrintF function
:param dest: Destination string
:param mask: Pattern string
:type dest: str_ref
:type mask: str
.. versionadded:: 7.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
dest.value = gxapi_cy.WrapSTR._printf(GXContext._get_tls_geo(), dest.value.encode(), mask.encode())
[docs] @classmethod
def replace_char(cls, istr, old, new_char):
"""
Replaces characters in a string.
:param istr: String to modify
:param old: Character to replace (first character only)
:param new_char: Replacement character (first character only)
:type istr: str_ref
:type old: str
:type new_char: str
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the input replacement character is "", then the
string will be truncated at the first character to replace.
"""
istr.value = gxapi_cy.WrapSTR._replace_char(GXContext._get_tls_geo(), istr.value.encode(), old.encode(), new_char.encode())
[docs] @classmethod
def replace_char2(cls, istr, old, new_char):
"""
Replaces characters in a string, supports simple removal.
:param istr: String to modify
:param old: Character to replace (first character only)
:param new_char: Replacement character (first character only)
:type istr: str_ref
:type old: str
:type new_char: str
.. versionadded:: 6.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** If the replacement character is "" (NULL character)
then the character to replace is removed from the
input string, and the string is shortened.
"""
istr.value = gxapi_cy.WrapSTR._replace_char2(GXContext._get_tls_geo(), istr.value.encode(), old.encode(), new_char.encode())
[docs] @classmethod
def replace_multi_char(cls, istr, old, new_char):
"""
Replaces multiple characters in a string.
:param istr: String to modify
:param old: Characters to replace
:param new_char: Replacement characters
:type istr: str_ref
:type old: str
:type new_char: str
.. versionadded:: 5.1.5
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The number of characters to replace must equal
the number of replacement characters.
"""
istr.value = gxapi_cy.WrapSTR._replace_multi_char(GXContext._get_tls_geo(), istr.value.encode(), old.encode(), new_char.encode())
[docs] @classmethod
def replace_non_ascii(cls, str_val, rpl):
"""
Replace non-ASCII characters in a string.
:param str_val: String to modify
:param rpl: Replacement character
:type str_val: str_ref
:type rpl: str
.. versionadded:: 6.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** All characthers > 127 will be replaced by the first character
of the replacement string.
"""
str_val.value = gxapi_cy.WrapSTR._replace_non_ascii(GXContext._get_tls_geo(), str_val.value.encode(), rpl.encode())
[docs] @classmethod
def set_char(cls, str_val, ascii):
"""
Set a string's first character using an ASCII value of a character.
:param str_val: String
:param ascii: ASCII value
:type str_val: str_ref
:type ascii: int
.. versionadded:: 5.1.4
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
str_val.value = gxapi_cy.WrapSTR._set_char(GXContext._get_tls_geo(), str_val.value.encode(), ascii)
[docs] @classmethod
def trim_quotes(cls, str_val):
"""
Remove double quotes.
:param str_val: String to trim
:type str_val: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** THE STRING IS MODIFIED.
This method goes through the string and removes all spaces in a
string except those enclosed in quotes. It then removes
any quotes. It is usfull for trimming unwanted spaces from
an input string but allows the user to use quotes as well.
If a quote follows a backslash, the quote is retained and
the backslash is deleted. These quotes are NOT treated as
delimiters.
"""
str_val.value = gxapi_cy.WrapSTR._trim_quotes(GXContext._get_tls_geo(), str_val.value.encode())
[docs] @classmethod
def trim_space(cls, str_val, trim):
"""
Remove leading and/or trailing whitespace.
:param str_val: String to trim
:param trim: :ref:`STR_TRIM`
:type str_val: str_ref
:type trim: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** THE STRING IS MODIFIED.
Whitespace characters are defined as space, tab, carriage return,
new line, vertical tab or formfeed (0x09 to 0x0D, 0x20)
"""
str_val.value = gxapi_cy.WrapSTR._trim_space(GXContext._get_tls_geo(), str_val.value.encode(), trim)
[docs] @classmethod
def un_quote(cls, str_val):
"""
Remove double quotes from string
:param str_val: String to unquote
:type str_val: str_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** THE STRING IS MODIFIED.
The pointers will be advanced past a first character
quote and a last character quote will be set to .\\0'.
Both first and last characters must be quotes for the
triming to take place.
"""
str_val.value = gxapi_cy.WrapSTR._un_quote(GXContext._get_tls_geo(), str_val.value.encode())
# Misc
[docs] @classmethod
def gen_group_name(cls, istr1, istr2, istr3, ostr):
"""
Generate a group name string
from type string, database and channel(optional) strings..
:param istr1: Input type string (static part)
:param istr2: Input db string
:param istr3: Input ch string (could be 0 length)
:param ostr: Output group name string
:type istr1: str
:type istr2: str
:type istr3: str
:type ostr: str_ref
.. versionadded:: 5.1.4
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The output group name string is formed in the way of typestr_dbstr_chstr.
If the database/channel strings is too long to fit the output string
(max total length of 1040, including the NULL ending), then
the typestr will always be kept the full length to be the first part,
while the dbstr and/or chstr will be shortened to be the
second and/or third part of the output string.
.. seealso::
GenNewGroupName_MVIEW
"""
ostr.value = gxapi_cy.WrapSTR._gen_group_name(GXContext._get_tls_geo(), istr1.encode(), istr2.encode(), istr3.encode(), ostr.value.encode())
# Tokenizing
[docs] @classmethod
def count_tokens(cls, str_val, delims):
"""
Counts number of tokens.
:param str_val: String to tokenize
:param delims: Delimiter characters
:type str_val: str
:type delims: str
:returns: Number of tokens in the string.
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Delimiters are "soft" in that one or more delimiters
is considered a single delimiter, and preceding and
trailing delimiters are ignored.
DO NOT use this function except in GXC code. The corresponding
`get_token <geosoft.gxapi.GXSTR.get_token>` function will not operate correctly in GX.Net code.
"""
ret_val = gxapi_cy.WrapSTR._count_tokens(GXContext._get_tls_geo(), str_val.encode(), delims.encode())
return ret_val
[docs] @classmethod
def get_token(cls, dest, orig, tok):
"""
Get a token from a tokenized string.
:param dest: Destination string
:param orig: Tokenized string
:param tok: Token number wanted (0 is the first!)
:type dest: str_ref
:type orig: str
:type tok: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Call `tokens <geosoft.gxapi.GXSTR.tokens>` to prepare the tokenized
string.
You MUST NOT get tokens beyond number of tokens returned
by `tokens <geosoft.gxapi.GXSTR.tokens>` or `tokens2 <geosoft.gxapi.GXSTR.tokens2>`.
The first token has index 0.
DO NOT use this function except in GXC code.
`get_token <geosoft.gxapi.GXSTR.get_token>` function will not operate correctly in GX.Net code.
.. seealso::
`tokens <geosoft.gxapi.GXSTR.tokens>`, GetToken_STR
"""
dest.value = gxapi_cy.WrapSTR._get_token(GXContext._get_tls_geo(), dest.value.encode(), orig.encode(), tok)
[docs] @classmethod
def tokenize(cls, str_val, soft, hard, esc, quote):
"""
Tokenize a string based on any characters.
:param str_val: `GXSTR <geosoft.gxapi.GXSTR>` - String containing token(s)
:param soft: szSoft - Soft delimiters (spaces/tabs)
:param hard: szHard - Hard delimiters (commas)
:param esc: szEsc - Escape delimiters (back-slash)
:param quote: szQuote- Quote delimiters (quote characters)
:type str_val: str_ref
:type soft: str
:type hard: str
:type esc: str
:type quote: str
:returns: Number of tokens
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** This uses a finite state machine to tokenize on these
rules:
1. Any one character following an escape delimiter is
treated as a normal character.
2. Any characters inside a quote string are treated as
normal characters.
3. Any number of Soft delimiters in sequence without a
hard delimiter are treated as one hard delimited.
4. Any number of soft delimiters can preceed or follow
a hard delimiter and are ignored.
EXAMPLE
Soft = [ ] Hard = [,] Escape = [\\] Quote = ["]
[this is a , , the "test," of , \\,\\" my delimite fi,]
Results in:
[this] [is] [a] [] [the] ["test,"] [of] [\\,\\"] [my] [delimite] [fi] []
NOT use this function except in GXC code. The corresponding
etToken_STR function will not operate correctly in GX.Net code.
.. seealso::
GetToken_STR
"""
ret_val, str_val.value = gxapi_cy.WrapSTR._tokenize(GXContext._get_tls_geo(), str_val.value.encode(), soft.encode(), hard.encode(), esc.encode(), quote.encode())
return ret_val
[docs] @classmethod
def tokens(cls, str_val, delims):
"""
Tokenize a string
:param str_val: String to tokenize
:param delims: Delimiter characters
:type str_val: str_ref
:type delims: str
:returns: Number of tokens, maximum is 2048
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Delimiters in the string are reduced to a single NULL.
Delimiters withing double quoted strings are ignored.
Use GetToken_STR to extract tokens.
DO NOT use this function except in GXC code. The corresponding
`get_token <geosoft.gxapi.GXSTR.get_token>` function will not operate correctly in GX.Net code.
.. seealso::
`tokens2 <geosoft.gxapi.GXSTR.tokens2>`, GetToken_STR
"""
ret_val, str_val.value = gxapi_cy.WrapSTR._tokens(GXContext._get_tls_geo(), str_val.value.encode(), delims.encode())
return ret_val
[docs] @classmethod
def tokens2(cls, str_val, soft, hard, esc, quote):
"""
General tokenize a string
:param str_val: String to tokenize
:param soft: szSoft - Soft delimiters (spaces/tabs)
:param hard: szHard - Hard delimiters (commas)
:param esc: szEsc - Escape delimiters (back-slash)
:param quote: szQuote- Quote delimiters (quote characters)
:type str_val: str_ref
:type soft: str
:type hard: str
:type esc: str
:type quote: str
:returns: Number of Tokens
:rtype: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** This function is for old GX compatibility only.
See `tokenize <geosoft.gxapi.GXSTR.tokenize>`.
DO NOT use this function except in GXC code. The corresponding
`get_token <geosoft.gxapi.GXSTR.get_token>` function will not operate correctly in GX.Net code.
"""
ret_val, str_val.value = gxapi_cy.WrapSTR._tokens2(GXContext._get_tls_geo(), str_val.value.encode(), soft.encode(), hard.encode(), esc.encode(), quote.encode())
return ret_val
[docs] @classmethod
def parse_list(cls, str_val, gvv):
"""
Parse a tokenized list to get a selection list.
:param str_val: String to be parsed
:param gvv: Selection Buffer to fill
:type str_val: str
:type gvv: GXVV
.. versionadded:: 5.0.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Given a list such as "1,3,4,6-9,12", it fills the
input buffer with 1 if the number is selected,
0 if not. The items are delimited with spaces
or commas, and ranges are acceptable, either using
a "-" or ":", e.g. 3-6 and 3:6 both mean 3,4,5, and 6.
Only values from 0 to one less than the buffer length
are used. Out-of-range values are ignored.
"""
gxapi_cy.WrapSTR._parse_list(GXContext._get_tls_geo(), str_val.encode(), gvv)
### endblock ClassImplementation
### block ClassExtend
# NOTICE: The code generator will not replace the code in this block
### endblock ClassExtend
### block Footer
# NOTICE: The code generator will not replace the code in this block
### endblock Footer