IexThrowErrnoExc.h 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. ///////////////////////////////////////////////////////////////////////////
  2. //
  3. // Copyright (c) 2002-2012, 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. #ifndef INCLUDED_IEXTHROWERRNOEXC_H
  35. #define INCLUDED_IEXTHROWERRNOEXC_H
  36. //----------------------------------------------------------
  37. //
  38. // A function which throws ExcErrno exceptions
  39. //
  40. //----------------------------------------------------------
  41. #include "IexBaseExc.h"
  42. #include "IexExport.h"
  43. IEX_INTERNAL_NAMESPACE_HEADER_ENTER
  44. //--------------------------------------------------------------------------
  45. //
  46. // Function throwErrnoExc() throws an exception which corresponds to
  47. // error code errnum. The exception text is initialized with a copy
  48. // of the string passed to throwErrnoExc(), where all occurrences of
  49. // "%T" have been replaced with the output of strerror(oserror()).
  50. //
  51. // Example:
  52. //
  53. // If opening file /tmp/output failed with an ENOENT error code,
  54. // calling
  55. //
  56. // throwErrnoExc ();
  57. //
  58. // or
  59. //
  60. // throwErrnoExc ("%T.");
  61. //
  62. // will throw an EnoentExc whose text reads
  63. //
  64. // No such file or directory.
  65. //
  66. // More detailed messages can be assembled using stringstreams:
  67. //
  68. // std::stringstream s;
  69. // s << "Cannot open file " << name << " (%T).";
  70. // throwErrnoExc (s);
  71. //
  72. // The resulting exception contains the following text:
  73. //
  74. // Cannot open file /tmp/output (No such file or directory).
  75. //
  76. // Alternatively, you may want to use the THROW_ERRNO macro defined
  77. // in IexMacros.h:
  78. //
  79. // THROW_ERRNO ("Cannot open file " << name << " (%T).")
  80. //
  81. //--------------------------------------------------------------------------
  82. IEX_EXPORT void throwErrnoExc(const std::string &txt, int errnum);
  83. IEX_EXPORT void throwErrnoExc(const std::string &txt);
  84. IEX_EXPORT void throwErrnoExc();
  85. IEX_INTERNAL_NAMESPACE_HEADER_EXIT
  86. #endif // INCLUDED_IEXTHROWERRNOEXC_H