[Include] [INC] strlib v1.3 - Simple string modification (Update: 21/10/09)

[Westie]

strlib - v1.3

Missed PHP's excellent string modification functions? Yeah, but that was because it was easy. I decided to create a string include that is stand alone - each function works in or out of the include - no dependencies apart from the core supplied files. But why? Because I can, and I wanted it. I wanted to be able to effectively cut strings up into pieces, remove stupid white space from lines in files, remove certain characters from certain words for a certain effect, or even replace whole words if you want to. You can do what ever you want, within reason, with this.

Function tests prove efficiency, albeit outdated efficiency!

Function list
Remember that this is the function list that you need to know, the full documentation is in the source code.

/*
    str_replace:
        Case sensitive string replace

    Arguments:
        sSearch[]    String to search for
        sReplace[]   String to replace with
        sSubject[]   Original string
        (op) &iCount  How many times 'sSearch' has been replaced.

    Returns:
        Replaced string.
*/
native str_replace(sSearch[], sReplace[], const sSubject[], &iCount = 0)

/*
    str_ireplace:
        Case insensitive string replace

    Arguments:
        sSearch[]    String to search for
        sReplace[]   String to replace with
        sSubject[]   Original string
        (op) &iCount  How many times 'sSearch' has been replaced.

    Returns:
        Replaced string.
*/
native str_ireplace(sSearch[], sReplace[], const sSubject[], &iCount = 0)

/*
    str_pad:
        Pad a string with characters until the defined amount.

    Arguments:
        sSource[]     String input to pad.
        iPadLength    Pad to amount. If less than sSource, sSource is returned.
        (op) cPadChar  Character to use as padding.

    Returns:
        Padded string.
*/
native str_pad(const sSource[], iPadLength, cPadChar = ' ')

/*
    str_repeat:
        Repeats a string 'iMultiplier' times.

    Arguments:
        sSource[]   String to be repeated
        iMultiplier Amount of times to be repeated

    Returns:
        Repeated string.
*/
native str_repeat(const sSource[], iMultiplier)

/*
    str_rot13:
        Rotates alphabetical characters 13 characters along.

    Arguments:
        sSource[]   String to be rotated

    Returns:
        Rotated string.
*/
native str_rot13(const sSource[])

/*
    strtr:
        Removes 'sRemove' from the string and replaces
        that character from 'sReplace'.

    Arguments:
        sSource[]   String to be transformed
        sRemove[]  Characters to be removed (must be in same order as below!)
        sReplace[]  Characters to be replaced (must be in same order as above!)

    Returns:
        Trimmed string.
*/
native strtr(const sSource[], sRemove[], sReplace[])

/*
    substr:
        Gets a substring from a string.

    Arguments:
        sSource[]   String to be substring'd.
        iStart    Position for the start of substring.
        iLength    Position for the end of substring.
                (if negative, cells away from end)

    Returns:
        Substring.
*/
native substr(const sSource[], iStart, iLength = sizeof(sSource))

/*
    trim:
        Removes whitespace, tabs, and new lines
        from the beginning and end of 'sSource'.

    Arguments:
        sSource[]   String to be trimmed

    Returns:
        Trimmed string.
*/
native trim(const sSource[])

/*
    rtrim:
        Removes whitespace, tabs, and new lines
        from the end of 'sSource'.

    Arguments:
        sSource[]   String to be trimmed

    Returns:
        Trimmed string.
*/
native rtrim(const sSource[])

/*
    ltrim:
        Removes whitespace, tabs, and new lines
        from the beginning of 'sSource'.

    Arguments:
        sSource[]   String to be trimmed

    Returns:
        Trimmed string.
*/
native ltrim(const sSource[])

/*
    implode:
        Returns a string where the array has been stuck back together
        again.

    Arguments:
        aPieces[][]  The array to glue back together.
        sGlue     The string to use as the glue.

    Returns:
        The imploded string.
*/
native implode(const aPieces[][], const sGlue[] = " ")

/*
    explode:
        Creates an array of values from 'sSource', where only the exact amount of
        values matching sizeof(aExplode) are returned.

    Arguments:
        aExplode[][] The exploded array
        sSource[]   Source string.
        sDelimiter  The string to use as the delimiter.

    Returns:
        Returns -1 on failure, otherwise success.
*/
native explode(aExplode[][], sSource[], sDelimiter[] = " ")

/*
    explodea:
        Creates an array of values from 'sSource', where any overrun is stored in
        the final node.

    Arguments:
        aExplode[][] The exploded array
        sSource[]   Source string.
        sDelimiter  The string to use as the delimiter.

    Returns:
        Returns -1 on failure, otherwise success.
*/
native explodea(aExplode[][], sSource[], sDelimiter[] = " ")

/*
    str_in_array:
        Checks if a string matches any of the strings in the array.

    Arguments:
        sNeedle[]   String that is being matched.
        aHaystack[][] Array with strings to be searched,

    Returns:
        Returns true on a match.
*/
native str_in_array(sNeedle[], aHaystack[][])

Download: http://files.typefish.co.uk/sa-mp/strlib.inc
-> No mirrors thanks.

Fancy documentation: http://docs.typefish.co.uk/samp/pawn/strlib/

Any problems, post in the topic. See ya!

[Chaprnks]

Hmm, I will definitely make use of this in the future.

[NeRoSiS]

This is extremely useful, nice job!

[Westie]

Alright, I have modified strtr so that you are able to remove characters all together. Check the first post for details.

[Correlli]

Good work.

[GTA_Rules]

Nice work Westie

[yezizhu]

Very useful, good job!

[James_Alex]

cool

[Westie]

Updated, added functions for exploding strings! Kaboom.

[GTA_Rules]

Sorry I don't get what explode does, could you explain me? If it does what I think it does, I could use it :+