xref: /arkcompiler/ets_runtime/ecmascript/jspandafile/js_pandafile_executor.h

/*
 * Copyright (c) 2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ECMASCRIPT_JSPANDAFILE_JS_PANDAFILE_EXECUTOR_H
#define ECMASCRIPT_JSPANDAFILE_JS_PANDAFILE_EXECUTOR_H

#include "ecmascript/ecma_context.h"
#include "ecmascript/js_tagged_value.h"
#include "ecmascript/js_thread.h"
#include "ecmascript/jspandafile/js_pandafile.h"
#include "ecmascript/module/js_module_source_text.h"

namespace panda::ecmascript {
class JSPandaFileExecutor {
public:
    static constexpr int ROUTE_SUCCESS = 0;
    static constexpr int ROUTE_INTERNAL_ERROR = 100001;
    static constexpr int ROUTE_URI_ERROR = 100002;

    std::pair<CString, CString> ParseEntryPointWithUnifiedRules(EcmaVM *vm, const CString &filename,
                                                                std::string_view entryPoint);
    static std::pair<CString, CString> ParseAbcEntryPoint(JSThread *thread, const CString &filename,
                                                          [[maybe_unused]] std::string_view entryPoint);
    static Expected<JSTaggedValue, bool> ExecuteFromFile(JSThread *thread, const CString &name,
                                                         CString entry, bool needUpdate = false,
                                                         bool executeFromJob = false);
    static Expected<JSTaggedValue, bool> ExecuteFromAbsolutePathAbcFile(JSThread *thread, const CString &filename,
                                                                        std::string_view entryPoint,
                                                                        bool needUpdate = false,
                                                                        bool executeFromJob = false);
    static Expected<JSTaggedValue, bool> ExecuteFromAbcFile(JSThread *thread, const CString &filename,
                                                            std::string_view entryPoint, bool needUpdate = false,
                                                            bool executeFromJob = false);
    static Expected<JSTaggedValue, bool> ExecuteFromBuffer(JSThread *thread, const void *buffer, size_t size,
                                                           std::string_view entryPoint, const CString &filename = "",
                                                           bool needUpdate = false, bool executeFromJob = false);
    static Expected<JSTaggedValue, bool> ExecuteModuleBuffer(JSThread *thread, const void *buffer, size_t size,
                                                             const CString &filename = "", bool needUpdate = false);
    static Expected<JSTaggedValue, bool> CommonExecuteBuffer(JSThread *thread, bool isBundle, const CString &filename,
                                                             const CString &entry, const void *buffer, size_t size,
                                                             bool executeFromJob = false);
    static Expected<JSTaggedValue, bool> Execute(JSThread *thread, const JSPandaFile *jsPandaFile,
                                                 std::string_view entryPoint, bool executeFromJob = false);
    static void BindPreloadedPandaFilesToAOT(EcmaVM *vm, const std::string &moduleName);
    static void BindPandaFileToAot(JSPandaFile *jsPandaFile);
    static Expected<JSTaggedValue, bool> ExecuteSpecialModule(JSThread *thread, const CString &recordName,
                                                              const CString &filename, const JSPandaFile *jsPandaFile,
                                                              const JSRecordInfo* recordInfo);
    static Expected<JSTaggedValue, bool> LazyExecuteModule(JSThread *thread, CString &recordName,
                                                           const CString &filename, bool isMergedAbc);
    // Execute from secure mem
    static Expected<JSTaggedValue, bool> ExecuteFromBufferSecure(JSThread *thread, uint8_t *buffer, size_t size,
                                                                 std::string_view entryPoint,
                                                                 const CString &filename = "", bool needUpdate = false);
    static Expected<JSTaggedValue, bool> ExecuteModuleBufferSecure(JSThread *thread, uint8_t *buffer, size_t size,
                                                                   const CString &filename = "",
                                                                   bool needUpdate = false);
    static Expected<JSTaggedValue, bool> CommonExecuteBuffer(JSThread *thread, const CString &filename,
                                                             const CString &entry, const JSPandaFile *jsPandaFile);
    static Expected<JSTaggedValue, bool> ExecuteSecureWithOhmUrl(JSThread *thread, uint8_t *buffer,
                                                                 size_t size, const CString &fileName,
                                                                 const CString &entryPoint);

    static int ExecuteAbcFileWithSingletonPatternFlag(JSThread *thread,
        [[maybe_unused]] const CString &bundleName, const CString &moduleName, const CString &entry,
        bool isSingletonPattern);

    static bool IsExecuteModuleInAbcFile(JSThread *thread, [[maybe_unused]] const CString &bundleName,
        const CString &moduleName, const CString &entry);
};
}  // namespace panda::ecmascript
#endif // ECMASCRIPT_JSPANDAFILE_JS_PANDAFILE_EXECUTOR_H