• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef JS_PRINT_EXTENSION_H
17 #define JS_PRINT_EXTENSION_H
18 
19 #include "napi/native_api.h"
20 #include "print_extension.h"
21 #include "print_job.h"
22 
23 class NativeReference;
24 class NativeValue;
25 class NativeObject;
26 
27 namespace OHOS {
28 namespace AbilityRuntime {
29 class PrintExtension;
30 class JsRuntime;
31 /**
32  * @brief Basic Print components.
33  */
34 class JsPrintExtension : public PrintExtension, public std::enable_shared_from_this<JsPrintExtension> {
35 public:
36     JsPrintExtension(JsRuntime &jsRuntime);
37     virtual ~JsPrintExtension() override;
38 
39     /**
40      * @brief Create JsPrintExtension.
41      *
42      * @param runtime The runtime.
43      * @return The JsPrintExtension instance.
44      */
45     static JsPrintExtension *Create(const std::unique_ptr<Runtime> &runtime);
46 
47     /**
48      * @brief Init the extension.
49      *
50      * @param record the extension record.
51      * @param application the application info.
52      * @param handler the extension handler.
53      * @param token the remote token.
54      */
55     virtual void Init(const std::shared_ptr<AppExecFwk::AbilityLocalRecord> &record,
56         const std::shared_ptr<AppExecFwk::OHOSApplication> &application,
57         std::shared_ptr<AppExecFwk::AbilityHandler> &handler, const sptr<IRemoteObject> &token) override;
58 
59     /**
60      * @brief Called when this extension is started. You must override this function if you want to perform some
61      *        initialization operations during extension startup.
62      *
63      * This function can be called only once in the entire lifecycle of an extension.
64      * @param Want Indicates the {@link Want} structure containing startup information about the extension.
65      */
66     virtual void OnStart(const AAFwk::Want &want) override;
67 
68     /**
69      * @brief Called when this Print extension is connected for the first time.
70      *
71      * You can override this function to implement your own processing logic.
72      *
73      * @param want Indicates the {@link Want} structure containing connection information about the Print extension.
74      * @return Returns a pointer to the <b>sid</b> of the connected Print extension.
75      */
76     virtual sptr<IRemoteObject> OnConnect(const AAFwk::Want &want) override;
77 
78     /**
79      * @brief Called when all abilities connected to this Print extension are disconnected.
80      *
81      * You can override this function to implement your own processing logic.
82      *
83      */
84     virtual void OnDisconnect(const AAFwk::Want &want) override;
85 
86     /**
87      * @brief Called back when Print is started.
88      * This method can be called only by Print. You can use the StartAbility(ohos.aafwk.content.Want) method
89      * to start Print. Then the system calls back the current method to use the transferred want parameter
90      * to execute its own logic.
91      *
92      * @param want Indicates the want of Print to start.
93      * @param restart Indicates the startup mode. The value true indicates that Print is restarted after being
94      * destroyed, and the value false indicates a normal startup.
95      * @param startId Indicates the number of times the Print extension has been started. The startId is incremented
96      * by 1 every time the extension is started. For example, if the extension has been started for six times, the
97      * value of startId is 6.
98      */
99     virtual void OnCommand(const AAFwk::Want &want, bool restart, int startId) override;
100 
101     /**
102      * @brief Called when this extension enters the <b>STATE_STOP</b> state.
103      *
104      * The extension in the <b>STATE_STOP</b> is being destroyed.
105      * You can override this function to implement your own processing logic.
106      */
107     virtual void OnStop() override;
108 
109 private:
110     NativeValue *CallObjectMethod(const char *name, NativeValue *const *argv = nullptr, size_t argc = 0);
111     bool InitExtensionObj(JsRuntime &jsRuntime);
112     bool InitContextObj(JsRuntime &jsRuntime, NativeObject *&extObj, std::string &extensionId);
113     void RegisterDiscoveryCb();
114     void RegisterConnectionCb();
115     void RegisterPrintJobCb();
116     void RegisterPreviewCb();
117     void RegisterQueryCapCb();
118     void RegisterExtensionCb();
119     void RegisterCb();
120 
121     void GetSrcPath(std::string &srcPath);
122 
123     JsRuntime &jsRuntime_;
124     std::unique_ptr<NativeReference> jsObj_;
125     static JsPrintExtension *jsExtension_;
126     std::string extensionId_;
127     bool hasDestroyed_;
128 };
129 } // namespace AbilityRuntime
130 } // namespace OHOS
131 #endif // JS_PRINT_EXTENSION_H