1 ///////////////////////////////////////////////////////////////////////////
3 // Copyright (c) 2002, Industrial Light & Magic, a division of Lucas
6 // All rights reserved.
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions are
11 // * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
17 // * Neither the name of Industrial Light & Magic nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 ///////////////////////////////////////////////////////////////////////////
37 #ifndef INCLUDED_IEXTHROWERRNOEXC_H
38 #define INCLUDED_IEXTHROWERRNOEXC_H
40 //----------------------------------------------------------
42 // A function which throws ExcErrno exceptions
44 //----------------------------------------------------------
46 #include "IexBaseExc.h"
51 //--------------------------------------------------------------------------
53 // Function throwErrnoExc() throws an exception which corresponds to
54 // error code errnum. The exception text is initialized with a copy
55 // of the string passed to throwErrnoExc(), where all occurrences of
56 // "%T" have been replaced with the output of strerror(oserror()).
60 // If opening file /tmp/output failed with an ENOENT error code,
67 // throwErrnoExc ("%T.");
69 // will throw an EnoentExc whose text reads
71 // No such file or directory.
73 // More detailed messages can be assembled using stringstreams:
75 // std::stringstream s;
76 // s << "Cannot open file " << name << " (%T).";
79 // The resulting exception contains the following text:
81 // Cannot open file /tmp/output (No such file or directory).
83 // Alternatively, you may want to use the THROW_ERRNO macro defined
86 // THROW_ERRNO ("Cannot open file " << name << " (%T).")
88 //--------------------------------------------------------------------------
90 void throwErrnoExc (const std::string &txt, int errnum);
91 void throwErrnoExc (const std::string &txt = "%T." /*, int errnum = oserror() */);