Back to index

lightning-sunbird  0.9+nobinonly
rcbase.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039 ** RCBase.h - Mixin class for NSPR C++ wrappers
00040 */
00041 
00042 #if defined(_RCRUNTIME_H)
00043 #else
00044 #define _RCRUNTIME_H
00045 
00046 #include <prerror.h>
00047 
00048 /*
00049 ** Class: RCBase (mixin)
00050 **
00051 ** Generally mixed into every base class. The functions in this class are all
00052 ** static. Therefore this entire class is just syntatic sugar. It gives the
00053 ** illusion that errors (in particular) are retrieved via the same object
00054 ** that just reported a failure. It also (unfortunately) might lead one to
00055 ** believe that the errors are persistent in that object. They're not.
00056 */
00057 
00058 class PR_IMPLEMENT(RCBase)
00059 {
00060 public:
00061     virtual ~RCBase();
00062 
00063     static void AbortSelf();
00064 
00065     static PRErrorCode GetError();
00066     static PRInt32 GetOSError();
00067 
00068     static PRSize GetErrorTextLength();
00069     static PRSize CopyErrorText(char *text);
00070 
00071     static void SetError(PRErrorCode error, PRInt32 oserror);
00072     static void SetErrorText(PRSize textLength, const char *text);
00073 
00074 protected:
00075     RCBase() { }
00076 };  /* RCObject */
00077 
00078 inline PRErrorCode RCBase::GetError() { return PR_GetError(); }
00079 inline PRInt32 RCBase::GetOSError() { return PR_GetOSError(); }
00080 
00081 #endif  /* defined(_RCRUNTIME_H) */
00082 
00083 /* rcbase.h */