Home | History | Annotate | Download | only in Iex
      1 ///////////////////////////////////////////////////////////////////////////
      2 //
      3 // Copyright (c) 2002, Industrial Light & Magic, a division of Lucas
      4 // Digital Ltd. LLC
      5 //
      6 // All rights reserved.
      7 //
      8 // Redistribution and use in source and binary forms, with or without
      9 // modification, are permitted provided that the following conditions are
     10 // met:
     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
     16 // distribution.
     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.
     20 //
     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.
     32 //
     33 ///////////////////////////////////////////////////////////////////////////
     34 
     35 
     36 
     37 #ifndef INCLUDED_IEXTHROWERRNOEXC_H
     38 #define INCLUDED_IEXTHROWERRNOEXC_H
     39 
     40 //----------------------------------------------------------
     41 //
     42 //	A function which throws ExcErrno exceptions
     43 //
     44 //----------------------------------------------------------
     45 
     46 #include "IexBaseExc.h"
     47 
     48 namespace Iex {
     49 
     50 
     51 //--------------------------------------------------------------------------
     52 //
     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()).
     57 //
     58 // Example:
     59 //
     60 // If opening file /tmp/output failed with an ENOENT error code,
     61 // calling
     62 //
     63 //	throwErrnoExc ();
     64 //
     65 // or
     66 //
     67 //	throwErrnoExc ("%T.");
     68 //
     69 // will throw an EnoentExc whose text reads
     70 //
     71 //	No such file or directory.
     72 //
     73 // More detailed messages can be assembled using stringstreams:
     74 //
     75 //	std::stringstream s;
     76 //	s << "Cannot open file " << name << " (%T).";
     77 //	throwErrnoExc (s);
     78 //
     79 // The resulting exception contains the following text:
     80 //
     81 //	Cannot open file /tmp/output (No such file or directory).
     82 //
     83 // Alternatively, you may want to use the THROW_ERRNO macro defined
     84 // in IexMacros.h:
     85 //
     86 //	THROW_ERRNO ("Cannot open file " << name << " (%T).")
     87 //
     88 //--------------------------------------------------------------------------
     89 
     90 void throwErrnoExc (const std::string &txt, int errnum);
     91 void throwErrnoExc (const std::string &txt = "%T." /*, int errnum = oserror() */);
     92 
     93 
     94 } // namespace Iex
     95 
     96 #endif
     97