Back to index

lightning-sunbird  0.9+nobinonly
nsAEClassDispatcher.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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 Mozilla Communicator client code.
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
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Simon Fraser <sfraser@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 
00040 #ifndef __AECLASSDISPATCHER__
00041 #define __AECLASSDISPATCHER__
00042 
00043 
00044 #include "patricia.h"
00045 
00046 // this class is used to dispatch calls to handlers on the basis of their class. It avoids
00047 // us having to switch on the class in the code.
00048 
00049 class AEGenericClass;
00050 
00051 class AEDispatchHandler
00052 {
00053 public:
00054                                           AEDispatchHandler(DescType handlerClass, AEGenericClass* handler, Boolean deleteOnRemove = true);
00055                                           ~AEDispatchHandler();
00056                                           
00057                                           
00058        void                               DispatchEvent(                                   AEDesc *                    token,
00059                                                                                            const AppleEvent *   appleEvent,
00060                                                                                            AppleEvent *         reply);
00061 
00062        void                               GetProperty(                              DescType                    desiredClass,
00063                                                                                            const AEDesc*        containerToken,
00064                                                                                            DescType                    containerClass,
00065                                                                                            DescType                    keyForm,
00066                                                                                            const AEDesc*        keyData,
00067                                                                                            AEDesc*                     resultToken);
00068                                                                                            
00069        void                               GetDataFromListOrObject(                  const AEDesc *              tokenOrTokenList,
00070                                                                                            AEDesc *                    desiredTypes,
00071                                                                                            AEDesc *                    data);
00072 
00073        void                               GetItemFromContainer(                     DescType                    desiredClass,
00074                                                                                            const AEDesc*        containerToken,
00075                                                                                            DescType                    containerClass, 
00076                                                                                            DescType                    keyForm,
00077                                                                                            const AEDesc*        keyData,
00078                                                                                            AEDesc*                     resultToken);
00079 
00080        void                               CompareObjects(                           DescType                    comparisonOperator,
00081                                                                                            const AEDesc *              object,
00082                                                                                            const AEDesc *              descriptorOrObject,
00083                                                                                            Boolean *                   result);
00084 
00085 
00086        void                               CountObjects(                             DescType                    desiredType,
00087                                                                                            DescType                    containerClass,
00088                                                                                            const AEDesc *              container,
00089                                                                                            long *               result);
00090 
00091        void                               CreateSelfSpecifier(                      const AEDesc *              token,
00092                                                                                            AEDesc *                    outSpecifier);
00093                                                                                            
00094 protected:
00095        
00096        Boolean                            mDeleteHandler;
00097        DescType                           mHandlerClass;
00098        AEGenericClass*             mHandler;
00099 };
00100 
00101 
00102 
00103 class AEDispatchTree
00104 {
00105 public:
00106                                           AEDispatchTree();
00107                                           ~AEDispatchTree();
00108                                           
00109        void                               InsertHandler(DescType handlerClass, AEGenericClass *handler, Boolean isDuplicate = false);
00110        AEDispatchHandler*          FindHandler(DescType handlerClass);
00111        
00112 protected:
00113 
00114        enum {
00115               kDuplicateKeyError = 750
00116        };
00117        
00118        static int                         FreeDispatchTreeNodeData(void *nodeData, unsigned char *key, void *refCon);
00119        static int                         ReplaceDispatchTreeNode(void *nodeData, unsigned char *key, void *replaceData);
00120        
00121        
00122 protected:
00123 
00124        PatriciaTreeRef             mTree;
00125 };
00126 
00127 
00128 
00129 #endif /* __AECLASSDISPATCHER__ */
00130