Skip to content

Have one source of truth for the language transitions #7648

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

Merged
dlang-bot merged 4 commits into from
Jan 16, 2018
Merged

Have one source of truth for the language transitions #7648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4b3169
Generate transition automatically
wilzbach Jan 9, 2018
b3901ac
Generate transition flags automatically
wilzbach Jan 9, 2018
8aea46f
Regenerate MAN file before preview
wilzbach Jan 9, 2018
e2dd34a
Automatically generate all transitions
wilzbach Jan 9, 2018
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
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export DIFFABLE

build: $(addprefix $G/, $(DMD_MAN_PAGE) $(OTHER_MAN_PAGES))

preview:
preview: $(MAN_PAGE)
man -l $G/$(DMD_MAN_PAGE)

################################################################################
Expand Down
20 changes: 19 additions & 1 deletion docs/gen_man.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ string bold(string w)
return `\fI` ~ w ~ `\fR`;
}

// capitalize the first letter
auto capitalize(string w)
{
import std.range, std.uni;
return w.take(1).asUpperCase.chain(w.dropOne);
}

void main()
{
import std.algorithm, std.array, std.conv, std.datetime, std.range, std.stdio, std.uni;
Expand Down Expand Up @@ -112,9 +119,20 @@ void main()
}
writefln(".IP -%s", flag);
// Capitalize the first letter
writeln(help.take(1).asUpperCase.chain(help.dropOne));
writeln(help.capitalize);
}
}

writeln(`.SH TRANSITIONS
Language changes listed by \fB-transition=id\fR:`);
foreach (transition; Usage.transitions)
{
string additionalOptions;
if (transition.bugzillaNumber)
additionalOptions = "," ~ transition.bugzillaNumber;
writefln(".IP %s%s", transition.name.bold, additionalOptions);
writeln(transition.helpText.capitalize);
}

writefln(footer, now.year);
}
72 changes: 56 additions & 16 deletions src/dmd/cli.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,21 @@ bool isCurrentTargetOS(TargetOS os)
return (os & targetOS) > 0;
}

/// Representation of a CLI `Option`
struct Option
{
string flag; /// The CLI flag without leading `-`, e.g. `color`
string helpText; /// A detailed description of the flag
TargetOS os = TargetOS.all; /// For which `TargetOS` the flags are applicable
}

/**
Contains all available CLI $(LREF Option)s.

See_Also: $(LREF Option)
*/
struct Usage
{
/// Representation of a CLI `Option`
struct Option
{
string flag; /// The CLI flag without leading `-`, e.g. `color`
string helpText; /// A detailed description of the flag
TargetOS os = TargetOS.all; /// For which `TargetOS` the flags are applicable
}

/// Returns all available CLI options
static immutable options = [
Option("allinst",
Expand Down Expand Up @@ -316,6 +316,31 @@ struct Usage
"write JSON file to filename"
),
];

/// Representation of a CLI transition
struct Transition
{
string bugzillaNumber; /// bugzilla issue number (if existent)
string name; /// name of the transition
string paramName; // internal transition parameter name
string helpText; // detailed description of the transition
}

/// Returns all available transitions
static immutable transitions = [
Transition("3449", "field", "vfield",
"list all non-mutable fields which occupy an object instance"),
Transition("10378", "import", "bug10378",
"revert to single phase name lookup"),
Transition(null, "checkimports", "check10378",
"give deprecation messages about 10378 anomalies"),
Transition("14488", "complex", "vcomplex",
"give deprecation messages about all usages of complex or imaginary types"),
Transition("16997", "intpromote", "fix16997",
"fix integral promotions for unary + - ~ operators"),
Transition(null, "tls", "vtls",
"list all variables going into thread local storage"),
];
}

/**
Expand Down Expand Up @@ -377,14 +402,29 @@ CPU architectures supported by -mcpu=id:
/// Language changes listed by -transition=id
static string transitionUsage()
{
return "Language changes listed by -transition=id:
=all list information on all language changes
=checkimports give deprecation messages about 10378 anomalies
=complex,14488 give deprecation messages about all usages of complex or imaginary types
=field,3449 list all non-mutable fields which occupy an object instance
=import,10378 revert to single phase name lookup
=intpromote,16997 fix integral promotions for unary + - ~ operators
=tls list all variables going into thread local storage
enum maxFlagLength = 20;
enum s = () {
auto buf = "Language changes listed by -transition=id:
";
auto allTransitions = [Usage.Transition(null, "all", null,
"list information on all language changes")] ~ Usage.transitions;
foreach (t; allTransitions)
{
buf ~= " =";
buf ~= t.name;
auto lineLength = 3 + t.name.length;
if (t.bugzillaNumber !is null)
{
buf ~= "," ~ t.bugzillaNumber;
lineLength += t.bugzillaNumber.length + 1;
}
foreach (i; 0 .. maxFlagLength - lineLength)
buf ~= " ";
buf ~= t.helpText;
buf ~= "\n";
}
return buf;
}();
return s;
}
}
63 changes: 28 additions & 35 deletions src/dmd/mars.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1696,53 +1696,46 @@ private bool parseCommandLine(const ref Strings arguments, const size_t argc, re
if (num == uint.max)
goto Lerror;

string generateTransitionsNumbers()
{
import dmd.cli : Usage;
string buf;
foreach (t; Usage.transitions)
{
if (t.bugzillaNumber !is null)
buf ~= `case `~t.bugzillaNumber~`: params.`~t.paramName~` = true;break;`;
}
return buf;
}

// Bugzilla issue number
switch (num)
{
case 3449:
params.vfield = true;
break;
case 10378:
params.bug10378 = true;
break;
case 14488:
params.vcomplex = true;
break;
case 16997:
params.fix16997 = true;
break;
mixin(generateTransitionsNumbers());
default:
goto Lerror;
}
}
else if (Identifier.isValidIdentifier(p + 12))
{
string generateTransitionsText()
{
import dmd.cli : Usage;
string buf = `case "all":`;
foreach (t; Usage.transitions)
buf ~= `params.`~t.paramName~` = true;`;
buf ~= "break;";

foreach (t; Usage.transitions)
{
buf ~= `case "`~t.name~`": params.`~t.paramName~` = true;break;`;
}
return buf;
}
const ident = p + 12;
switch (ident[0 .. strlen(ident)])
{
case "all":
params.vtls = true;
params.vfield = true;
params.vcomplex = true;
Copy link
Contributor Author

@wilzbach wilzbach Jan 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look ma, this was already outdated.

break;
case "checkimports":
params.check10378 = true;
break;
case "complex":
params.vcomplex = true;
break;
case "field":
params.vfield = true;
break;
case "import":
params.bug10378 = true;
break;
case "intpromote":
params.fix16997 = true;
break;
case "tls":
params.vtls = true;
break;
mixin(generateTransitionsText());
default:
goto Lerror;
}
Expand Down