aermicioi.aedi.exception.di_exception source code

1 /**
2 License:
3 	Boost Software License - Version 1.0 - August 17th, 2003
4 
5 	Permission is hereby granted, free of charge, to any person or organization
6 	obtaining a copy of the software and accompanying documentation covered by
7 	this license (the "Software") to use, reproduce, display, distribute,
8 	execute, and transmit the Software, and to prepare derivative works of the
9 	Software, and to permit third-parties to whom the Software is furnished to
10 	do so, all subject to the following:
11 
12 	The copyright notices in the Software and this entire statement, including
13 	the above license grant, this restriction and the following disclaimer,
14 	must be included in all copies of the Software, in whole or in part, and
15 	all derivative works of the Software, unless such copies or derivative
16 	works are solely in the form of machine-executable object code generated by
17 	a source language processor.
18 
19 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 	FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
22 	SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
23 	FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
24 	ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 	DEALINGS IN THE SOFTWARE.
26 
27 Authors:
28 	aermicioi
29 **/
30 module aermicioi.aedi.exception.di_exception;
31 
32 import std.exception;
33 import aermicioi.aedi.util.range : BufferSink;
34 
35 @safe:
36 
37 /**
38 General type of exception thrown by library.
39 
40 General type of exception thrown by library.
41 All kind of exceptions should inherit from this base one.
42 Used as well for general types of exceptions that do not fit in certain
43 category.
44 **/
45 class AediException : Exception {
46 
47     /**
48     Identity of offending component.
49     **/
50     string identity;
51 
52     /**
53      * Creates a new instance of Exception. The nextInChain parameter is used
54      * internally and should always be $(D null) when passed by user code.
55      * This constructor does not automatically throw the newly-created
56      * Exception; the $(D throw) statement should be used for that purpose.
57      */
58     pure nothrow this(string msg, string identity, string file = __FILE__, size_t line = __LINE__, Throwable next = null)
59     {
60         this.identity = identity;
61         super(msg, file, line, next);
62     }
63 
64     /**
65     ditto
66     **/
67     nothrow this(string msg, string identity, Throwable next, string file = __FILE__, size_t line = __LINE__)
68     {
69         this.identity = identity;
70         super(msg, file, line, next);
71     }
72 
73     mixin AdvancedExceptionPrinting;
74 
75     /**
76     A special function used to print customized message using built-in properties, with as less as possible allocations.
77 
78     Params:
79         sink = sink where message will end.
80     **/
81     void pushMessage(scope void delegate(in char[]) sink) const @system {
82         import std.algorithm : substitute;
83         import std.utf : byChar;
84 		auto substituted = this.msg.substitute("${identity}", identity).byChar;
85 
86         while (!substituted.empty) {
87             auto buffer = BufferSink!(char[256])();
88             buffer.put(substituted);
89 
90             sink(buffer.slice);
91         }
92     }
93 
94     alias toString = typeof(super).toString;
95 }
96 
97 /**
98 A mixin injecting modified version of toString which uses pushMessage instead of msg.
99 **/
100 mixin template AdvancedExceptionPrinting() {
101 	override void toString(scope void delegate(in char[]) sink) const @system
102     {
103         import core.internal..string : unsignedToTempString;
104 
105         char[20] tmpBuff = void;
106 
107         sink(typeid(this).name);
108         sink("@"); sink(file);
109         sink("("); sink(unsignedToTempString(line, tmpBuff, 10)); sink(")");
110 
111         if (msg.length)
112         {
113             sink(": "); pushMessage(sink);
114         }
115         if (info)
116         {
117             try
118             {
119                 sink("\n----------------");
120                 foreach (t; info)
121                 {
122                     sink("\n"); sink(t);
123                 }
124             }
125             catch (Throwable)
126             {
127                 // ignore more errors
128             }
129         }
130     }
131 }