diff options
Diffstat (limited to 'wildcard.h')
| -rw-r--r-- | wildcard.h | 62 |
1 files changed, 31 insertions, 31 deletions
@@ -1,4 +1,4 @@ -/** \file wildcard.h +/** \file wildcard.h My own globbing implementation. Needed to implement this instead of using libs globbing to support tab-expansion of globbed @@ -31,41 +31,41 @@ class completion_t; */ enum { - /** Character representing any character except '/' */ - ANY_CHAR = WILDCARD_RESERVED, + /** Character representing any character except '/' */ + ANY_CHAR = WILDCARD_RESERVED, - /** Character representing any character string not containing '/' (A slash) */ - ANY_STRING, + /** Character representing any character string not containing '/' (A slash) */ + ANY_STRING, - /** Character representing any character string */ - ANY_STRING_RECURSIVE, + /** Character representing any character string */ + ANY_STRING_RECURSIVE, } - ; + ; /** - Expand the wildcard by matching against the filesystem. + Expand the wildcard by matching against the filesystem. - New strings are allocated using malloc and should be freed by the caller. + New strings are allocated using malloc and should be freed by the caller. - wildcard_expand works by dividing the wildcard into segments at - each directory boundary. Each segment is processed separatly. All - except the last segment are handled by matching the wildcard - segment against all subdirectories of matching directories, and - recursively calling wildcard_expand for matches. On the last - segment, matching is made to any file, and all matches are - inserted to the list. + wildcard_expand works by dividing the wildcard into segments at + each directory boundary. Each segment is processed separatly. All + except the last segment are handled by matching the wildcard + segment against all subdirectories of matching directories, and + recursively calling wildcard_expand for matches. On the last + segment, matching is made to any file, and all matches are + inserted to the list. - If wildcard_expand encounters any errors (such as insufficient - priviliges) during matching, no error messages will be printed and - wildcard_expand will continue the matching process. + If wildcard_expand encounters any errors (such as insufficient + priviliges) during matching, no error messages will be printed and + wildcard_expand will continue the matching process. - \param wc The wildcard string - \param base_dir The base directory of the filesystem to perform the match against - \param flags flags for the search. Can be any combination of ACCEPT_INCOMPLETE and EXECUTABLES_ONLY - \param out The list in which to put the output + \param wc The wildcard string + \param base_dir The base directory of the filesystem to perform the match against + \param flags flags for the search. Can be any combination of ACCEPT_INCOMPLETE and EXECUTABLES_ONLY + \param out The list in which to put the output + + \return 1 if matches where found, 0 otherwise. Return -1 on abort (I.e. ^C was pressed). - \return 1 if matches where found, 0 otherwise. Return -1 on abort (I.e. ^C was pressed). - */ int wildcard_expand_string(const wcstring &wc, const wcstring &base_dir, expand_flags_t flags, std::vector<completion_t> &out ); /** @@ -87,10 +87,10 @@ int wildcard_has( const wchar_t *str, int internal ); Test wildcard completion */ bool wildcard_complete(const wcstring &str, - const wchar_t *wc, - const wchar_t *desc, - wcstring (*desc_func)(const wcstring &), - std::vector<completion_t> &out, - expand_flags_t flags ); + const wchar_t *wc, + const wchar_t *desc, + wcstring (*desc_func)(const wcstring &), + std::vector<completion_t> &out, + expand_flags_t flags ); #endif |