add errorsink.d, an abstract interface to error messages #14906
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| /** | ||
| * Provides an abstraction for what to do with error messages. | ||
| * | ||
| * Copyright: Copyright (C) 2023 by The D Language Foundation, All Rights Reserved | ||
| * Authors: $(LINK2 https://www.digitalmars.com, Walter Bright) | ||
| * License: $(LINK2 https://www.boost.org/LICENSE_1_0.txt, Boost License 1.0) | ||
| * Source: $(LINK2 https://github.com/dlang/dmd/blob/master/src/dmd/errorsink.d, _errorsink.d) | ||
| * Documentation: https://dlang.org/phobos/dmd_errorsink.html | ||
| * Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/errorsink.d | ||
| */ | ||
|
|
||
| module dmd.errorsink; | ||
|
|
||
| import dmd.location; | ||
|
|
||
| /*************************************** | ||
| * Where error/warning/deprecation messages go. | ||
| */ | ||
| abstract class ErrorSink | ||
|
Contributor
There was a problem hiding this comment. Reuse existing wheels or explain why they are insufficient. Such deficiencies might include Note also that
Member
Author
There was a problem hiding this comment.
This line illustrates the insufficiency: This is the wrong abstraction. The user of Lexer should be able to send the errors anywhere, baking into the API "stderr" or not is insufficent. It's other insufficiency is it is centered around a pointer to a function which overrides the default behavior. This is a primitive form of OOP that fell out of favor in the 1980s. The abstract class, for which the user adds derived classes with specific behaviors, is the more modern approach. The abstract class designer does not have to anticipate what the implementation classes will be doing.
Member
Author
There was a problem hiding this comment. I don't want to touch dmd.frontend in this PR. As I mentioned to @ibuclaw it needs a significant overhaul.
Contributor
There was a problem hiding this comment. Then I consider this PR to require approval from @jacob-carlborg before merging.
I do not trust you will ever get around to this. And this adds yet more files without packaging things properly and I trust even less that you will ever do that.
So can
Where? why? (Hint, no it doesn't). |
||
| { | ||
| nothrow: | ||
| extern (C++): | ||
|
|
||
| void error(const ref Loc loc, const(char)* format, ...); | ||
|
|
||
| void errorSupplemental(const ref Loc loc, const(char)* format, ...); | ||
|
|
||
| void warning(const ref Loc loc, const(char)* format, ...); | ||
|
Member
Author
There was a problem hiding this comment. I only added the ones used. |
||
|
|
||
| void deprecation(const ref Loc loc, const(char)* format, ...); | ||
|
|
||
| void deprecationSupplemental(const ref Loc loc, const(char)* format, ...); | ||
| } | ||
|
Member
There was a problem hiding this comment.
Member
Author
There was a problem hiding this comment. I only added the ones used. Others can be added as necessary. |
||
|
|
||
| /***************************************** | ||
| * Just ignores the messages. | ||
| */ | ||
| class ErrorSinkNull : ErrorSink | ||
| { | ||
| nothrow: | ||
| extern (C++): | ||
| override: | ||
|
|
||
| void error(const ref Loc loc, const(char)* format, ...) { } | ||
|
|
||
| void errorSupplemental(const ref Loc loc, const(char)* format, ...) { } | ||
|
|
||
| void warning(const ref Loc loc, const(char)* format, ...) { } | ||
|
|
||
| void deprecation(const ref Loc loc, const(char)* format, ...) { } | ||
|
|
||
| void deprecationSupplemental(const ref Loc loc, const(char)* format, ...) { } | ||
| } | ||
|
|
||
| /***************************************** | ||
| * Simplest implementation, just sends messages to stderr. | ||
| */ | ||
| class ErrorSinkStderr : ErrorSink | ||
| { | ||
| import core.stdc.stdio; | ||
| import core.stdc.stdarg; | ||
|
|
||
| nothrow: | ||
| extern (C++): | ||
| override: | ||
|
|
||
| void error(const ref Loc loc, const(char)* format, ...) | ||
| { | ||
| fputs("Error: ", stderr); | ||
|
Contributor
There was a problem hiding this comment. Shouldn't |
||
| const p = loc.toChars(); | ||
| if (*p) | ||
| { | ||
| fprintf(stderr, "%s: ", p); | ||
| //mem.xfree(cast(void*)p); // loc should provide the free() | ||
| } | ||
|
|
||
| va_list ap; | ||
| va_start(ap, format); | ||
| vfprintf(stderr, format, ap); | ||
| fputc('\n', stderr); | ||
| va_end(ap); | ||
| } | ||
|
|
||
| void errorSupplemental(const ref Loc loc, const(char)* format, ...) { } | ||
|
|
||
| void warning(const ref Loc loc, const(char)* format, ...) | ||
| { | ||
| fputs("Warning: ", stderr); | ||
| const p = loc.toChars(); | ||
| if (*p) | ||
| { | ||
| fprintf(stderr, "%s: ", p); | ||
| //mem.xfree(cast(void*)p); // loc should provide the free() | ||
| } | ||
|
|
||
| va_list ap; | ||
| va_start(ap, format); | ||
| vfprintf(stderr, format, ap); | ||
| fputc('\n', stderr); | ||
| va_end(ap); | ||
| } | ||
|
|
||
| void deprecation(const ref Loc loc, const(char)* format, ...) | ||
| { | ||
| fputs("Deprecation: ", stderr); | ||
| const p = loc.toChars(); | ||
| if (*p) | ||
| { | ||
| fprintf(stderr, "%s: ", p); | ||
| //mem.xfree(cast(void*)p); // loc should provide the free() | ||
| } | ||
|
|
||
| va_list ap; | ||
| va_start(ap, format); | ||
| vfprintf(stderr, format, ap); | ||
| fputc('\n', stderr); | ||
| va_end(ap); | ||
| } | ||
|
|
||
| void deprecationSupplemental(const ref Loc loc, const(char)* format, ...) { } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated change, should be its own commit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another case of tabs being converted to spaces by my checkin procedure. Not worth another PR.