summaryrefslogtreecommitdiffstats
path: root/image/ImageLogging.h
blob: c36f4e8dbdac3014a8a142132adfa51a3613f466 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_image_ImageLogging_h
#define mozilla_image_ImageLogging_h

#include "mozilla/Logging.h"
#include "Image.h"
#include "nsIURI.h"
#include "prinrval.h"

static mozilla::LazyLogModule gImgLog("imgRequest");

#define GIVE_ME_MS_NOW() PR_IntervalToMilliseconds(PR_IntervalNow())

using mozilla::LogLevel;

class LogScope {
 public:
  LogScope(mozilla::LogModule* aLog, void* aFrom, const char* aFunc)
      : mLog(aLog), mFrom(aFrom), mFunc(aFunc) {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s {ENTER}\n", GIVE_ME_MS_NOW(), mFrom, mFunc));
  }

  /* const char * constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, const char* paramValue)
      : mLog(aLog), mFrom(from), mFunc(fn) {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%s\") {ENTER}\n", GIVE_ME_MS_NOW(), mFrom,
             mFunc, paramName, paramValue));
  }

  /* void ptr constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, const void* paramValue)
      : mLog(aLog), mFrom(from), mFunc(fn) {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=%p) {ENTER}\n", GIVE_ME_MS_NOW(), mFrom,
             mFunc, paramName, paramValue));
  }

  /* int32_t constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, int32_t paramValue)
      : mLog(aLog), mFrom(from), mFunc(fn) {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%d\") {ENTER}\n", GIVE_ME_MS_NOW(), mFrom,
             mFunc, paramName, paramValue));
  }

  /* uint32_t constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, uint32_t paramValue)
      : mLog(aLog), mFrom(from), mFunc(fn) {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%d\") {ENTER}\n", GIVE_ME_MS_NOW(), mFrom,
             mFunc, paramName, paramValue));
  }

  /* nsIURI constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, nsIURI* aURI)
      : mLog(aLog), mFrom(from), mFunc(fn) {
    if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
      static const size_t sMaxTruncatedLength = 1024;
      nsAutoCString spec("<unknown>");
      if (aURI) {
        aURI->GetSpec(spec);
        if (spec.Length() >= sMaxTruncatedLength) {
          spec.Truncate(sMaxTruncatedLength);
        }
      }
      MOZ_LOG(aLog, LogLevel::Debug,
              ("%d [this=%p] %s (%s=\"%s\") {ENTER}\n", GIVE_ME_MS_NOW(), from,
               fn, paramName, spec.get()));
    }
  }

  /* Image constructor */
  LogScope(mozilla::LogModule* aLog, void* from, const char* fn,
           const char* paramName, mozilla::image::Image* aImage)
      : LogScope(aLog, from, fn, paramName,
                 aImage ? aImage->GetURI() : nullptr) {}

  ~LogScope() {
    MOZ_LOG(mLog, LogLevel::Debug,
            ("%d [this=%p] %s {EXIT}\n", GIVE_ME_MS_NOW(), mFrom, mFunc));
  }

 private:
  mozilla::LogModule* mLog;
  void* mFrom;
  const char* mFunc;
};

class LogFunc {
 public:
  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn) {
    MOZ_LOG(aLog, LogLevel::Debug,
            ("%d [this=%p] %s\n", GIVE_ME_MS_NOW(), from, fn));
  }

  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn,
          const char* paramName, const char* paramValue) {
    MOZ_LOG(aLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%s\")\n", GIVE_ME_MS_NOW(), from, fn,
             paramName, paramValue));
  }

  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn,
          const char* paramName, const void* paramValue) {
    MOZ_LOG(aLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%p\")\n", GIVE_ME_MS_NOW(), from, fn,
             paramName, paramValue));
  }

  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn,
          const char* paramName, uint32_t paramValue) {
    MOZ_LOG(aLog, LogLevel::Debug,
            ("%d [this=%p] %s (%s=\"%d\")\n", GIVE_ME_MS_NOW(), from, fn,
             paramName, paramValue));
  }

  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn,
          const char* paramName, nsIURI* aURI) {
    if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
      static const size_t sMaxTruncatedLength = 1024;
      nsAutoCString spec("<unknown>");
      if (aURI) {
        aURI->GetSpec(spec);
        if (spec.Length() >= sMaxTruncatedLength) {
          spec.Truncate(sMaxTruncatedLength);
        }
      }
      MOZ_LOG(aLog, LogLevel::Debug,
              ("%d [this=%p] %s (%s=\"%s\")\n", GIVE_ME_MS_NOW(), from, fn,
               paramName, spec.get()));
    }
  }

  LogFunc(mozilla::LogModule* aLog, void* from, const char* fn,
          const char* paramName, mozilla::image::Image* aImage)
      : LogFunc(aLog, from, fn, paramName,
                aImage ? aImage->GetURI() : nullptr) {}
};

class LogMessage {
 public:
  LogMessage(mozilla::LogModule* aLog, void* from, const char* fn,
             const char* msg) {
    MOZ_LOG(aLog, LogLevel::Debug,
            ("%d [this=%p] %s -- %s\n", GIVE_ME_MS_NOW(), from, fn, msg));
  }
};

#define LOG_SCOPE_APPEND_LINE_NUMBER_PASTE(id, line) id##line
#define LOG_SCOPE_APPEND_LINE_NUMBER_EXPAND(id, line) \
  LOG_SCOPE_APPEND_LINE_NUMBER_PASTE(id, line)
#define LOG_SCOPE_APPEND_LINE_NUMBER(id) \
  LOG_SCOPE_APPEND_LINE_NUMBER_EXPAND(id, __LINE__)

#define LOG_SCOPE(l, s) \
  LogScope LOG_SCOPE_APPEND_LINE_NUMBER(LOG_SCOPE_TMP_VAR)(l, this, s)

#define LOG_SCOPE_WITH_PARAM(l, s, pn, pv) \
  LogScope LOG_SCOPE_APPEND_LINE_NUMBER(LOG_SCOPE_TMP_VAR)(l, this, s, pn, pv)

#define LOG_FUNC(l, s) LogFunc(l, this, s)

#define LOG_FUNC_WITH_PARAM(l, s, pn, pv) LogFunc(l, this, s, pn, pv)

#define LOG_STATIC_FUNC(l, s) LogFunc(l, nullptr, s)

#define LOG_STATIC_FUNC_WITH_PARAM(l, s, pn, pv) LogFunc(l, nullptr, s, pn, pv)

#define LOG_MSG(l, s, m) LogMessage(l, this, s, m)

#define LOG_MSG_WITH_PARAM LOG_FUNC_WITH_PARAM

#endif  // mozilla_image_ImageLogging_h