/*
 * 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 BUNDLE_ACTIVE_EVENT_H
#define BUNDLE_ACTIVE_EVENT_H

#include <cstdint>
#include <iosfwd>
#include <memory>
#include "parcel.h"

namespace OHOS {
namespace DeviceUsageStats {
class BundleActiveEvent : public Parcelable {
public:
    // external events
    static const int32_t ABILITY_FOREGROUND = 2; // onForeground() called, ability is in front.
    static const int32_t ABILITY_BACKGROUND = 3; // onBackground() called, ability is in background.
    static const int32_t ABILITY_STOP = 4; // onStop() called, ability is destroyed.
    static const int32_t LONG_TIME_TASK_STARTTED = 5;
    static const int32_t LONG_TIME_TASK_ENDED = 6;
    static const int32_t SYSTEM_INTERACTIVE = 7;
    static const int32_t USER_INTERACTIVE = 8;
    // internal events
    static const int32_t DEFAULT_EVENT_ID = 0;
    static const int32_t DEFAULT_UID_ID = -1;
    static const int32_t END_OF_THE_DAY = 9;
    static const int32_t SHUTDOWN = 10;
    static const int32_t STARTUP = 11;
    static const int32_t FLUSH = 12;
    static const int32_t SCREEN_INTERACTIVE = 13;
    static const int32_t SCREEN_NON_INTERACTIVE = 14;
    static const int32_t FORM_IS_CLICKED = 15;
    static const int32_t FORM_IS_REMOVED = 16;
    static const int32_t KEYGUARD_SHOWN = 17;
    static const int32_t KEYGUARD_HIDDEN = 18;
    static const int32_t NOTIFICATION_SEEN = 19;
    static const int32_t SYSTEM_LOCK = 20;
    static const int32_t SYSTEM_UNLOCK = 21;
    static const int32_t SYSTEM_SLEEP = 22;
    static const int32_t SYSTEM_WAKEUP = 23;
    inline static const std::string DEVICE_EVENT_PACKAGE_NAME = "openharmony";
    std::string bundleName_;
    std::string continuousTaskAbilityName_;
    std::string abilityName_;
    std::string abilityId_;
    std::string moduleName_;
    std::string formName_;
    int32_t formDimension_;
    int64_t formId_;
    int64_t timeStamp_;
    int32_t eventId_;
    int32_t uid_;

public:
    /*
    * function: BundleActiveEvent, default constructor.
    */
    BundleActiveEvent();
    /*
    * function: BundleActiveEvent, copy constructor.
    * parameters: orig
    */
    BundleActiveEvent(const BundleActiveEvent& orig);
    /*
    * function: BundleActiveEvent, constructor using event Id, time stamp.
    * parameters: eventId, timeStamp
    */
    BundleActiveEvent(int32_t eventId, int64_t timeStamp);
    /*
    * function: BundleActiveEvent, constructor using event Id, time stamp.
    * parameters: eventId, bundleName.
    */
    BundleActiveEvent(const int32_t eventId, const std::string bundleName, const int32_t uid = DEFAULT_UID_ID);
    /*
    * function: BundleActiveEvent, constructor of continuous task event.
    * parameters: bundleName, continuousTaskAbilityName
    */
    BundleActiveEvent(const std::string bundleName, const std::string continuousTaskAbilityName,
        const int32_t uid = DEFAULT_UID_ID);
    /*
    * function: BundleActiveEvent, constructor of app ability event.
    * parameters: bundleName, abilityName, abilityId
    */
    BundleActiveEvent(const std::string bundleName, const std::string abilityName, const std::string abilityId,
        const std::string moduleName, const int32_t uid = DEFAULT_UID_ID);
    /*
    * function: BundleActiveEvent, constructor of form event.
    * parameters: bundleName, moduleName, formName, formDimension, formId, eventId
    */
    BundleActiveEvent(const std::string bundleName, const std::string moduleName,
        const std::string formName, const int32_t formDimension, const int64_t formId, const int32_t eventId,
        const int32_t uid = DEFAULT_UID_ID);
    void PrintEvent(const bool debug) const;
    /*
    * function: operator=, override operator =.
    * parameters: orig
    * return: a BundleActiveEvent object same as orig.
    */
    BundleActiveEvent& operator=(const BundleActiveEvent& orig);
    /*
    * function: Marshalling, mashalling event object to parcel.
    * parameters: parcel
    * return: result of mashalling, true means successful, flase means failed.
    */
    virtual bool Marshalling(Parcel &parcel) const override;
    /*
    * function: UnMarshalling, Unmashalling event object from parcel.
    * parameters: parcel
    * return: point to a BundleActiveEvent.
    */
    static std::shared_ptr<BundleActiveEvent> UnMarshalling(Parcel &parcel);
    /*
    * function: ToString, change event object to string.
    * return: string of bundlename, timestamp, eventid.
    */
    std::string ToString();
    /**
    * @brief get if the event is reported by bundle usage.
    *
    * @return return true if event reported by bundle usage.
    */
    static bool IsBundleEvent(const int32_t eventId);
};
}  // namespace DeviceUsageStats
}  // namespace OHOS
#endif  // BUNDLE_ACTIVE_EVENT_H