lleventapi.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:3k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /**
  2.  * @file   lleventapi.h
  3.  * @author Nat Goodspeed
  4.  * @date   2009-10-28
  5.  * @brief  LLEventAPI is the base class for every class that wraps a C++ API
  6.  *         in an event API
  7.  * (see https://wiki.lindenlab.com/wiki/Incremental_Viewer_Automation/Event_API).
  8.  * 
  9.  * $LicenseInfo:firstyear=2009&license=viewergpl$
  10.  * 
  11.  * Copyright (c) 2009-2010, Linden Research, Inc.
  12.  * 
  13.  * Second Life Viewer Source Code
  14.  * The source code in this file ("Source Code") is provided by Linden Lab
  15.  * to you under the terms of the GNU General Public License, version 2.0
  16.  * ("GPL"), unless you have obtained a separate licensing agreement
  17.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  18.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  19.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  20.  * 
  21.  * There are special exceptions to the terms and conditions of the GPL as
  22.  * it is applied to this Source Code. View the full text of the exception
  23.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  24.  * online at
  25.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  26.  * 
  27.  * By copying, modifying or distributing this software, you acknowledge
  28.  * that you have read and understood your obligations described above,
  29.  * and agree to abide by those obligations.
  30.  * 
  31.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  32.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  33.  * COMPLETENESS OR PERFORMANCE.
  34.  * $/LicenseInfo$
  35.  */
  36. #if ! defined(LL_LLEVENTAPI_H)
  37. #define LL_LLEVENTAPI_H
  38. #include "lleventdispatcher.h"
  39. #include "llinstancetracker.h"
  40. #include <string>
  41. /**
  42.  * LLEventAPI not only provides operation dispatch functionality, inherited
  43.  * from LLDispatchListener -- it also gives us event API introspection.
  44.  * Deriving from LLInstanceTracker lets us enumerate instances.
  45.  */
  46. class LL_COMMON_API LLEventAPI: public LLDispatchListener,
  47.                   public LLInstanceTracker<LLEventAPI, std::string>
  48. {
  49.     typedef LLDispatchListener lbase;
  50.     typedef LLInstanceTracker<LLEventAPI, std::string> ibase;
  51. public:
  52.     /**
  53.      * @param name LLEventPump name on which this LLEventAPI will listen. This
  54.      * also serves as the LLInstanceTracker instance key.
  55.      * @param desc Documentation string shown to a client trying to discover
  56.      * available event APIs.
  57.      * @param field LLSD::Map key used by LLDispatchListener to look up the
  58.      * subclass method to invoke [default "op"].
  59.      */
  60.     LLEventAPI(const std::string& name, const std::string& desc, const std::string& field="op");
  61.     virtual ~LLEventAPI();
  62.     /// Get the string name of this LLEventAPI
  63.     std::string getName() const { return ibase::getKey(); }
  64.     /// Get the documentation string
  65.     std::string getDesc() const { return mDesc; }
  66.     /**
  67.      * Publish only selected add() methods from LLEventDispatcher.
  68.      * Every LLEventAPI add() @em must have a description string.
  69.      */
  70.     template <typename CALLABLE>
  71.     void add(const std::string& name,
  72.              const std::string& desc,
  73.              CALLABLE callable,
  74.              const LLSD& required=LLSD())
  75.     {
  76.         LLEventDispatcher::add(name, desc, callable, required);
  77.     }
  78. private:
  79.     std::string mDesc;
  80. };
  81. #endif /* ! defined(LL_LLEVENTAPI_H) */