InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CScriptRequestData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Jonathan W. Brown
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __CScriptRequestData__
25 #define __CScriptRequestData__
26 
27 #include "IScriptRequestData.h"
28 
29 #include <map>
30 
31 class IScript ;
32 
33 using namespace ScriptInfo ;
34 
35 typedef std::pair< InterfacePtr<IScript>, ScriptReturnDataList > ScriptTargetReturnDataPair ;
36 typedef std::map< InterfacePtr<IScript>, ScriptReturnDataList > ScriptTargetReturnDataList ;
37 typedef std::pair< ScriptList, ScriptReturnDataList > ScriptListReturnDataPair ;
38 typedef adobe::vector<ScriptListReturnDataPair> ScriptListReturnDataList ;
39 
40 
41 class CScriptRequestData : public CPMUnknown<IScriptRequestData>
42 {
43 public:
44  CScriptRequestData(IPMUnknown *boss);
45  virtual ~CScriptRequestData();
46 
47  virtual ErrorCode InsertRequestData( const ScriptID dataLocation, const ScriptData& data ) ;
48  virtual ErrorCode InsertRequestData( const ScriptRecordData& record ) ;
49  virtual ErrorCode ExtractRequestData( const ScriptID dataLocation, ScriptData& data ) const ;
50  virtual bool16 HasRequestData( const ScriptID dataLocation ) const ;
51  virtual ScriptRecordData GetRequestData() const ;
52 
53  virtual void ClearReturnData( const IScript* target ) ;
54  virtual void ClearReturnData( const ScriptList& targets ) ;
55  virtual void AppendReturnData( const IScript* target, const ScriptID requestID, const ErrorCode errorCode ) ;
56  virtual void AppendReturnData( const ScriptList& targets, const ScriptID requestID, const ErrorCode errorCode ) ;
57  virtual void AppendReturnData( const IScript* target, const ScriptID requestID, const ScriptData& returnValue ) ;
58  virtual void AppendReturnData( const ScriptList& targets, const ScriptID requestID, const ScriptData& returnValue ) ;
59  virtual void AppendReturnData( const IScript* target, const ScriptReturnData& data ) ;
60  virtual void AppendReturnData( const ScriptList& targets, const ScriptReturnData& data ) ;
61  virtual void ReplaceReturnData( const IScript* target, const ScriptReturnDataList& data ) ;
62  virtual void ReplaceReturnData( const ScriptList& targets, const ScriptReturnDataList& data ) ;
63  virtual void AppendReturnData( const IScript* target, const ScriptReturnDataList& data ) ;
64  virtual void AppendReturnData( const ScriptList& targets, const ScriptReturnDataList& data ) ;
65  virtual uint32 GetNumReturnData( const IScript* target ) const ;
66  virtual uint32 GetNumReturnData( const ScriptList& targets ) const ;
67  virtual ScriptReturnData GetNthReturnData( const IScript* target, uint32 n ) const ;
68  virtual ScriptReturnData GetNthReturnData( const ScriptList& targets, uint32 n ) const ;
69  virtual ScriptReturnDataList GetAllReturnData( const IScript* target ) const ;
70  virtual ScriptReturnDataList GetAllReturnData( const ScriptList& targets ) const ;
71 
72  virtual void SetErrorPolicy( ErrorPolicy policy ) ;
73  virtual ErrorPolicy GetErrorPolicy() const ;
74 
75  virtual void SetSetPropertiesOrderPolicy( SetPropertiesOrderPolicy policy ) ;
76  virtual SetPropertiesOrderPolicy GetSetPropertiesOrderPolicy() const ;
77 
78  virtual void SetTargetInfo( const ScriptElementID objectID ) ;
79  virtual void SetTargetInfo( const ObjectScriptElement* pObject ) ;
80  virtual const ObjectScriptElement* GetTargetInfo() const ;
81 
82  virtual const ScriptID GetDesiredType() const ;
83 
84  virtual RequestType GetRequestType() const ;
85  virtual const ScriptElement* GetRequestInfo() const ;
86 
87  virtual void SetMethod( const ScriptElementID methodID ) ;
88  virtual void SetMethod( const MethodScriptElement* pMethod ) ;
89  virtual bool16 IsMethod() const ;
90  virtual void SetMethodWithProperties( bool16 withProperties ) ;
91  virtual bool16 IsMethodWithProperties() const ;
92 
93  virtual void SetPropertyGet( const ScriptElementID propID ) ;
94  virtual void SetPropertyGet( const PropertyScriptElement* pProp ) ;
95  virtual bool16 IsPropertyGet() const ;
96 
97  virtual void SetPropertyPut( const ScriptElementID propID ) ;
98  virtual void SetPropertyPut( const PropertyScriptElement* pProp ) ;
99  virtual bool16 IsPropertyPut() const ;
100 
101  virtual void SetFindCollection( const ScriptElementID objID ) ;
102  virtual void SetFindCollection( const ObjectScriptElement* pObj ) ;
103  virtual bool16 IsFindCollection() const ;
104 
105  virtual void SetGetObject( const ScriptElementID objID, SpecifierForm accessorForm, const ScriptData& accessorData ) ;
106  virtual void SetGetObject( const ObjectScriptElement* pObj, SpecifierForm accessorForm, const ScriptData& accessorData ) ;
107  virtual bool16 IsGetObject() const ;
108  virtual SpecifierForm GetAccessorForm() const ;
109  virtual ScriptData GetAccessorData() const ;
110 
111  virtual void SetTargetHandlingPolicy( TargetHandlingPolicy policy ) ;
112  virtual TargetHandlingPolicy GetTargetHandlingPolicy() const ;
113 
114  virtual void SetRequestedDataType( const ScriptID requestedType ) ;
115  virtual const ScriptID GetRequestedDataType() const ;
116 
117  virtual void SetFormTestCaseSensitive( bool16 caseSensitive ) ;
118  virtual bool16 GetFormTestCaseSensitive() const ;
119 
120  // Access to the request context for this request
121  virtual const EngineContext& GetRequestContext() const ;
122  virtual void SetRequestContext( const EngineContext& context ) ;
123 
124  virtual void CloneRequestData( IScriptRequestData* other ) const ;
125  virtual void Reset() ;
126  virtual void Release() const ;
127 
128 protected:
132  virtual const ScriptRecordData& InternalGetRequestData() const ;
133 
134 private:
135  ScriptRecordData fRequestData ;
136  ScriptTargetReturnDataList fReturnData ; //return data for single targets
137  ScriptListReturnDataList fCollectiveReturnData ; //return data for collective targets
138  ErrorPolicy fErrorPolicy ;
139  SetPropertiesOrderPolicy fSetPropertiesOrderPolicy ;
140  const ObjectScriptElement* fTargetInfo ;
141  const ScriptElement* fRequestInfo ;
142  RequestType fRequestType ;
143  bool16 fIsMethodWithProperties ;
144  SpecifierForm fAccessorForm ;
145  ScriptData fAccessorData ;
146  TargetHandlingPolicy fHandlingPolicy ;
147  ScriptID fRequestedDataType ;
148  bool16 fFormTestCaseSensitive ;
149  EngineContext fRequestContext ;
150 };
151 
152 
153 #endif