visualtest/include/SDL_visualtest_parsehelper.h
author Sam Lantinga
Mon, 28 Aug 2017 00:22:23 -0700
changeset 11382 2c50e79b19e0
parent 7924 fcb86d323770
permissions -rw-r--r--
Renaming of guard header names to quiet -Wreserved-id-macro
     1 /* See COPYING.txt for the full license governing this code. */
     2 /**
     3  * \file SDL_visualtest_parsehelper.h
     4  *
     5  * Header with some helper functions for parsing strings.
     6  */
     7 
     8 #ifndef SDL_visualtest_parsehelper_h_
     9 #define SDL_visualtest_parsehelper_h_
    10 
    11 /* Set up for C function definitions, even when using C++ */
    12 #ifdef __cplusplus
    13 extern "C" {
    14 #endif
    15 
    16 /**
    17  * Takes an string of command line arguments and breaks them up into an array
    18  * based on whitespace.
    19  *
    20  * \param args The string of arguments.
    21  *
    22  * \return NULL on failure, an array of strings on success. The last element
    23  *         of the array is NULL. The first element of the array is NULL and should
    24  *         be set to the path of the executable by the caller.
    25  */
    26 char** SDLVisualTest_ParseArgsToArgv(char* args);
    27 
    28 /**
    29  * Takes a string and breaks it into tokens by splitting on whitespace.
    30  *
    31  * \param str The string to be split.
    32  * \param max_token_len Length of each element in the array to be returned.
    33  *
    34  * \return NULL on failure; an array of strings with the tokens on success. The
    35  *         last element of the array is NULL.
    36  */
    37 char** SDLVisualTest_Tokenize(char* str, int max_token_len);
    38 
    39 /* Ends C function definitions when using C++ */
    40 #ifdef __cplusplus
    41 }
    42 #endif
    43 
    44 #endif /* SDL_visualtest_parsehelper_h_ */
    45 
    46 /* vi: set ts=4 sw=4 expandtab: */