blob: 67a0dfdced359b0253e38e0b2fb4ae94a1163bf7 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include <cassert>
#include <string>
#include "base/base_export.h"
namespace tracked_objects {
// Location provides basic info where of an object was constructed, or was
// significantly brought to life.
class BASE_EXPORT Location {
// Constructor should be called with a long-lived char*, such as __FILE__.
// It assumes the provided value will persist as a global constant, and it
// will not make a copy of it.
Location(const char* function_name,
const char* file_name,
int line_number,
const void* program_counter);
// Provide a default constructor for easy of debugging.
// Copy constructor.
Location(const Location& other);
// Comparator for hash map insertion.
// No need to use |function_name_| since the other two fields uniquely
// identify this location.
bool operator==(const Location& other) const {
return line_number_ == other.line_number_ &&
file_name_ == other.file_name_;
const char* function_name() const { return function_name_; }
const char* file_name() const { return file_name_; }
int line_number() const { return line_number_; }
const void* program_counter() const { return program_counter_; }
std::string ToString() const;
// Translate the some of the state in this instance into a human readable
// string with HTML characters in the function names escaped, and append that
// string to |output|. Inclusion of the file_name_ and function_name_ are
// optional, and controlled by the boolean arguments.
void Write(bool display_filename, bool display_function_name,
std::string* output) const;
// Write function_name_ in HTML with '<' and '>' properly encoded.
void WriteFunctionName(std::string* output) const;
const char* function_name_;
const char* file_name_;
int line_number_;
const void* program_counter_;
// A "snapshotted" representation of the Location class that can safely be
// passed across process boundaries.
struct BASE_EXPORT LocationSnapshot {
// The default constructor is exposed to support the IPC serialization macros.
explicit LocationSnapshot(const tracked_objects::Location& location);
std::string file_name;
std::string function_name;
int line_number;
BASE_EXPORT const void* GetProgramCounter();
// Define a macro to record the current source location.
#define FROM_HERE_WITH_EXPLICIT_FUNCTION(function_name) \
::tracked_objects::Location(function_name, \
__FILE__, \
__LINE__, \
} // namespace tracked_objects
#endif // BASE_LOCATION_H_