Skip to content

Empty lines do not break options sections. #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EVGVir wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Empty lines do not break options sections. #52

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d997d40
Empty lines do not break options sections.
EVGVir Aug 1, 2016
fb64b5c
Regex in parse_section() is aligned with proposal for docopt.
EVGVir Aug 4, 2016
1c4b042
Wildcards are repalced with `[^\\n]` as a workaround for Boost.Regex.
EVGVir Aug 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Empty lines do not break options sections. 
There are several reasons why an options section can be split by an
empty line, among them are:
- logically grouping;
- aesthetic reasons.

Such style is used, for example, in 'man' program.

An example:
    Options:
      --before-empty-lines  An option before empty lines.

      --after-empty-lines   An option after empty lines.
  • Loading branch information
@EVGVir
EVGVir committed Aug 1, 2016
commit d997d4078deb63ccc9a7a05d273617d63d7b3fc1
4 changes: 2 additions & 2 deletions docopt.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ static std::vector<std::string> parse_section(std::string const& name, std::stri
std::regex const re_section_pattern {
"(?:^|\\n)" // anchored at a linebreak (or start of string)
"("
"[^\\n]*" + name + "[^\\n]*(?=\\n?)" // a line that contains the name
"(?:\\n[ \\t].*?(?=\\n|$))*" // followed by any number of lines that are indented
"[^\\n]*" + name + "[^\\n]*(?=\\n?)" // a line that contains the section name
"(?:\\n+[ \\t].*?(?=\\n|$))*" // followed by any number of indented or empty lines
")",
std::regex::icase
};
Expand Down
18 changes: 18 additions & 0 deletions testcases.docopt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,3 +955,21 @@ other options:
"""
$ prog --baz --egg
{"--foo": false, "--baz": true, "--bar": false, "--egg": true, "--spam": false}


# An empty line must not break an options section.
r"""
Usage: prog [options]

Options:
--before-empty-lines An option before empty lines.


--after-empty-lines An option after empty lines.
"""

$ prog --before-empty-lines
{"--before-empty-lines": true, "--after-empty-lines": false}

$ prog --after-empty-line
{"--before-empty-lines": false, "--after-empty-lines": true}