Home | History | Annotate | Download | only in shared
      1 /*
      2  * Copyright (C) 2017 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef CHRE_PLATFORM_PLATFORM_LOG_H_
     18 #define CHRE_PLATFORM_PLATFORM_LOG_H_
     19 
     20 #include "chre/target_platform/platform_log_base.h"
     21 #include "chre/util/singleton.h"
     22 
     23 namespace chre {
     24 
     25 /**
     26  * A logging class that platforms can supply an implementation and storage for.
     27  * Only one instance of this class is created by CHRE and is accessed via the
     28  * PlatformLogSingleton alias provided below.
     29  */
     30 class PlatformLog : public PlatformLogBase {
     31  public:
     32   /**
     33    * Allows the platform to initialize logging infrastructure.
     34    */
     35   PlatformLog();
     36 
     37   /**
     38    * Allows the platform to deinitialize logging infrastructure.
     39    */
     40   ~PlatformLog();
     41 
     42   /**
     43    * Logs message with printf-style arguments. No trailing newline is required
     44    * for this method.
     45    */
     46   void log(const char *formatStr, ...);
     47 };
     48 
     49 //! Provides an alias to the PlatformLog singleton.
     50 typedef Singleton<PlatformLog> PlatformLogSingleton;
     51 
     52 }  // namespace chre
     53 
     54 #endif  // CHRE_PLATFORM_PLATFORM_LOG_H_
     55