Git Product home page Git Product logo

wordsplit's Introduction

Wordsplit

Perform word splitting as done by *nix shells.

Build Status

What is "Word Splitting?"

Word splitting is the process of tokenizing a shell command (string) into words (tokens). For example, the command mv foo "bar baz" is comprised of three words: <mv>, <foo>, and <bar baz>. This library implements word splitting as a single function that behaves much like strsep and strtok. See wordsplit.h for details.

Installation

Copy wordsplit.c and wordsplit.h into your C project. The implementation only depends upon libc.

Usage

This example splits words on the space, tab, and new line characters.

#include "wordsplit.h"

char *s = strdup("The --quick=\"brown fox\" jumps\"o\"ver the 'lazy d'og.");
char *word, *sp = s;
while ((word = wordsplit(&sp, " \t\n")) != NULL)
{
    puts(word);
}
free(s);

The above code would print:

The
--quick=brown fox
jumpsover
the
lazy dog.

Prior Art

POSIX defines the wordexp function which performs word splitting, but it also performs shell expansion, e.g. it will expand environment variables like $PATH. Shell expansion may not be desirable depending on your needs.

This implementation of word splitting does not perform shell expansion, only tokenization.

Security Notes

The implementation is unit tested, fuzz tested, and sanitized via UBSan, ASan, and MSan.

License

This work is dedicated to the public domain.

wordsplit's People

Contributors

hgs3 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.