aermicioi.aedi_property_reader.helper.help_needing

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_property_reader.helper.help_needing_exception;
31 
32 import aermicioi.aedi_property_reader.helper.help_decorating_information_provider;
33 
34 /**
35 An exception that bubbles up to main function where it can be catched for proper
36 handling of wrong passed arguments, or missing arguments from command line or any other
37 source of properties.
38 **/
39 class HelpNeedingException : Exception {
40     private {
41         HelpInformationProvider[] providers;
42     }
43     
44     public {
45         /**
46         Constructor for HelpNeedingException
47         
48         Params: 
49             providers = a list of help providers used to print exception message.
50             file = file in which exception occured.
51             line = line at which exception was thrown.
52             next = next exception in chain of exceptions.
53         **/
54         @nogc @safe pure nothrow this(HelpInformationProvider[] providers, string file = __FILE__, size_t line = __LINE__, Throwable next = null)
55         {
56             this.providers = providers;
57             super(msg, file, line, next);
58         }
59     
60         /**
61         ditto
62         **/
63         @nogc @safe pure nothrow this(HelpInformationProvider[] providers, Throwable next, string file = __FILE__, size_t line = __LINE__)
64         {
65             this(providers, file, line, next);
66         }
67         
68         /**
69         Convert exception into a nice printable version.
70         
71         Params: 
72             sink = sink to where to print exception.
73         **/
74         override void toString(scope void delegate(in char[]) sink) const {
75             foreach (provider; this.providers) {
76                 provider.message(sink);
77                 sink("\n");
78             }
79             
80             debug {
81                 super.toString(sink);
82             }
83         }
84     }
85     
86 }