a6219cc3ef
This is a somewhat involved refactoring of this class. Here's an overview of the changes: * FileWrapper can now be used as a regular class and instances allocated on the stack. * The type now has support for move semantics and copy isn't allowed. * New public ctor with FILE* that can be used instead of OpenFromFileHandle. * New static Open() method. The intent of this is to allow opening a file and getting back a FileWrapper instance. Using this method instead of Create(), will allow us in the future to make the FILE* member pointer, to be const and simplify threading (get rid of the lock). * Rename the Open() method to is_open() and make it inline. * The FileWrapper interface is no longer a pure virtual interface. There's only one implementation so there's no need to go through a vtable for everything. * Functionality offered by the class, is now reduced. No support for looping (not clear if that was actually useful to users of that flag), no need to implement the 'read_only_' functionality in the class, since file APIs implement that already, no support for *not* managing the file handle (this wasn't used). OpenFromFileHandle always "manages" the file. * Delete the unused WriteText() method and don't support opening files in text mode. Text mode is only different on Windows and on Windows it translates \n to \r\n, which means that files such as log files, could have a slightly different format on Windows than other platforms. Besides, tools on Windows can handle UNIX line endings. * Remove FileName(), change Trace code to manage its own path. * Rename id_ member variable to file_. * Removed the open_ member variable since the same functionality can be gotten from just checking the file pointer. * Don't call CloseFile inside of Write. Write shouldn't be changing the state of the class beyond just attempting to write. * Remove concept of looping from FileWrapper and never close inside of Read() * Changed stream base classes to inherit from a common base class instead of both defining the Rewind method. Ultimately, Id' like to remove these interfaces and just have FileWrapper. * Remove read_only param from OpenFromFileHandle * Renamed size_in_bytes_ to position_, since it gets set to 0 when Rewind() is called (and the size actually does not change). * Switch out rw lock for CriticalSection. The r/w lock was only used for reading when checking the open_ flag. BUG= Review-Url: https://codereview.webrtc.org/2054373002 Cr-Commit-Position: refs/heads/master@{#13155}
90 lines
3.5 KiB
C++
90 lines
3.5 KiB
C++
/*
|
|
* Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*
|
|
* System independent wrapper for logging runtime information to file.
|
|
* Note: All log messages will be written to the same trace file.
|
|
* Note: If too many messages are written to file there will be a build up of
|
|
* messages. Apply filtering to avoid that.
|
|
*/
|
|
|
|
#ifndef WEBRTC_SYSTEM_WRAPPERS_INCLUDE_TRACE_H_
|
|
#define WEBRTC_SYSTEM_WRAPPERS_INCLUDE_TRACE_H_
|
|
|
|
#include "webrtc/common_types.h"
|
|
#include "webrtc/typedefs.h"
|
|
|
|
namespace webrtc {
|
|
|
|
#if defined(WEBRTC_RESTRICT_LOGGING)
|
|
// Disable all TRACE macros. The LOG macro is still functional.
|
|
#define WEBRTC_TRACE true ? (void) 0 : Trace::Add
|
|
#else
|
|
#define WEBRTC_TRACE Trace::Add
|
|
#endif
|
|
|
|
class Trace {
|
|
public:
|
|
// The length of the trace text preceeding the log message.
|
|
static const int kBoilerplateLength;
|
|
// The position of the timestamp text within a trace.
|
|
static const int kTimestampPosition;
|
|
// The length of the timestamp (without "delta" field).
|
|
static const int kTimestampLength;
|
|
|
|
// Increments the reference count to the trace.
|
|
static void CreateTrace();
|
|
// Decrements the reference count to the trace.
|
|
static void ReturnTrace();
|
|
// Note: any instance that writes to the trace file should increment and
|
|
// decrement the reference count on construction and destruction,
|
|
// respectively.
|
|
|
|
// Specifies what type of messages should be written to the trace file. The
|
|
// filter parameter is a bitmask where each message type is enumerated by the
|
|
// TraceLevel enumerator. TODO(hellner): why is the TraceLevel enumerator not
|
|
// defined in this file?
|
|
static void set_level_filter(int filter);
|
|
|
|
// Returns what type of messages are written to the trace file.
|
|
static int level_filter();
|
|
|
|
// Sets the file name. If add_file_counter is false the same file will be
|
|
// reused when it fills up. If it's true a new file with incremented name
|
|
// will be used.
|
|
static int32_t SetTraceFile(const char* file_name,
|
|
const bool add_file_counter = false);
|
|
|
|
// Registers callback to receive trace messages.
|
|
// TODO(hellner): Why not use OutStream instead? Why is TraceCallback not
|
|
// defined in this file?
|
|
static int32_t SetTraceCallback(TraceCallback* callback);
|
|
|
|
// Adds a trace message for writing to file. The message is put in a queue
|
|
// for writing to file whenever possible for performance reasons. I.e. there
|
|
// is a crash it is possible that the last, vital logs are not logged yet.
|
|
// level is the type of message to log. If that type of messages is
|
|
// filtered it will not be written to file. module is an identifier for what
|
|
// part of the code the message is coming.
|
|
// id is an identifier that should be unique for that set of classes that
|
|
// are associated (e.g. all instances owned by an engine).
|
|
// msg and the ellipsis are the same as e.g. sprintf.
|
|
// TODO(hellner) Why is TraceModule not defined in this file?
|
|
static void Add(const TraceLevel level,
|
|
const TraceModule module,
|
|
const int32_t id,
|
|
const char* msg, ...);
|
|
|
|
private:
|
|
static volatile int level_filter_;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // WEBRTC_SYSTEM_WRAPPERS_INCLUDE_TRACE_H_
|