/usr/include/log4shib/Category.hh is in liblog4shib-dev 1.0.9-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | /*
* Category.hh
*
* Copyright 2000, LifeLine Networks BV (www.lifeline.nl). All rights reserved.
* Copyright 2000, Bastiaan Bakker. All rights reserved.
*
* See the COPYING file for the terms of usage and distribution.
*/
#ifndef _LOG4SHIB_CATEGORY_HH
#define _LOG4SHIB_CATEGORY_HH
#include <log4shib/Portability.hh>
#include <log4shib/Appender.hh>
#include <log4shib/LoggingEvent.hh>
#include <log4shib/Priority.hh>
#include <log4shib/CategoryStream.hh>
#include <log4shib/threading/Threading.hh>
#include <map>
#include <vector>
#include <cstdarg>
#include <stdexcept>
namespace log4shib {
/**
* This is the central class in the log4j package. One of the distintive
* features of log4j (and hence log4shib) are hierarchal categories and
* their evaluation.
**/
class LOG4SHIB_EXPORT Category {
friend class HierarchyMaintainer;
public:
/**
* Return the root of the Category hierarchy.
*
* <p>The root category is always instantiated and available. It's
* name is the empty string.
* <p>Unlike in log4j, calling <code>Category.getInstance("")</code>
* <em>does</em> retrieve the root category
* and not a category just under root named "".
* @returns The root category
**/
static Category& getRoot();
/**
* Set the priority of the root Category.
* @param priority The new priority for the root Category
**/
static void setRootPriority(Priority::Value priority);
/**
* Get the priority of the <code>root</code> Category.
* @returns the priority of the root category
**/
static Priority::Value getRootPriority() throw();
/**
* Instantiate a Category with name <code>name</code>. This
* method does not set priority of the category which is by
* default <code>Priority::NOTSET</code>.
*
* @param name The name of the category to retrieve.
**/
static Category& getInstance(const std::string& name);
/**
* If the named category exists (in the default hierarchy) then it
* returns a reference to the category, otherwise it returns NULL.
* @since 0.2.7
**/
static Category* exists(const std::string& name);
/**
* Returns all the currently defined categories as a vector of
* Category pointers. Note: this function does not pass ownership
* of the categories in the vector to the caller, only the ownership
* of the vector. However vector<Category&>* is not legal C++,
* so we can't follow the default ownership conventions.
*
* <p>Unlike in log4j, the root category <em>is</em> included
* in the returned set.
*
* @since 0.3.2. Before 0.3.2 this method returned a std::set
**/
static std::vector<Category*>* getCurrentCategories();
/**
* This method will remove all Appenders from Categories.XXX
**/
static void shutdown();
/**
* Destructor for Category.
**/
virtual ~Category();
/**
* Return the category name.
* @returns The category name.
*/
virtual const std::string& getName() const throw();
/**
* Set the priority of this Category.
* @param priority The priority to set. Use Priority::NOTSET to let
* the category use its parents priority as effective priority.
* @exception std::invalid_argument if the caller tries to set
* Priority::NOTSET on the Root Category.
**/
virtual void setPriority(Priority::Value priority)
throw(std::invalid_argument);
/**
* Returns the assigned Priority, if any, for this Category.
* @return Priority - the assigned Priority, can be Priority::NOTSET
**/
virtual Priority::Value getPriority() const throw();
/**
* Starting from this Category, search the category hierarchy for a
* set priority and return it. Otherwise, return the priority
* of the root category.
*
* <p>The Category class is designed so that this method executes as
* quickly as possible.
**/
virtual Priority::Value getChainedPriority() const throw();
/**
* Returns true if the chained priority of the Category is equal to
* or higher than given priority.
* @param priority The priority to compare with.
* @returns whether logging is enable for this priority.
**/
virtual bool isPriorityEnabled(Priority::Value priority) const throw();
/**
* Adds an Appender to this Category.
* This method passes ownership from the caller to the Category.
* @since 0.2.7
* @param appender The Appender to wich this category has to log.
* @exception std::invalid_argument if the appender is NULL.
**/
virtual void addAppender(Appender* appender)
throw(std::invalid_argument);
/**
* Adds an Appender for this Category.
* This method does not pass ownership from the caller to the Category.
* @since 0.2.7
* @param appender The Appender this category has to log to.
**/
virtual void addAppender(Appender& appender);
/**
* Adds an Appender to this Category.
* This method passes ownership from the caller to the Category.
* @deprecated use addAppender(Appender*) or removeAllAppenders()
* instead.
* @param appender The Appender this category has to log to or NULL
* to remove the current Appenders.
**/
inline void setAppender(Appender* appender) {
if (appender) {
addAppender(appender);
} else {
removeAllAppenders();
}
};
/**
* Adds an Appender for this Category.
* This method does not pass ownership from the caller to the Category.
* @deprecated use addAppender(Appender&) instead.
* @param appender The Appender this category has to log to.
**/
inline void setAppender(Appender& appender) {
addAppender(appender);
};
/**
* Returns the first Appender for this Category, or NULL if no
* Appender has been set.
* @deprecated use getAppender(const std::string&)
* @returns The Appender.
**/
virtual Appender* getAppender() const;
/**
* Returns the specified Appender for this Category, or NULL if
* the Appender is not attached to this Category.
* @since 0.2.7
* @returns The Appender.
**/
virtual Appender* getAppender(const std::string& name) const;
/**
* Returns the set of Appenders currently attached to this Catogory.
* @since 0.3.1
* @returns The set of attached Appenders.
**/
virtual AppenderSet getAllAppenders() const;
/**
* Removes all appenders for this Category.
**/
virtual void removeAllAppenders();
/**
* Removes specified appender for this Category.
* @since 0.2.7
**/
virtual void removeAppender(Appender* appender);
/**
* Returns true if the Category owns the first Appender in its
* Appender set. In that case the Category destructor will delete
* the Appender.
* @deprecated use ownsAppender(Appender*)
**/
inline bool ownsAppender() const throw() {
return ownsAppender(getAppender());
};
/**
* Returns true if the Category owns the Appender. In that case the
* Category destructor will delete the Appender.
* @since 0.2.7
**/
virtual bool ownsAppender(Appender* appender) const throw();
/**
* Call the appenders in the hierarchy starting at
* <code>this</code>. If no appenders could be found, emit a
* warning.
*
* <p>This method always calls all the appenders inherited form the
* hierracy circumventing any evaluation of whether to log or not to
* log the particular log request.
*
* @param event the LogginEvent to log.
**/
virtual void callAppenders(const LoggingEvent& event) throw();
/**
* Set the additivity flag for this Category instance.
**/
virtual void setAdditivity(bool additivity);
/**
* Returns the additivity flag for this Category instance.
**/
virtual bool getAdditivity() const throw();
/**
* Returns the parent category of this category, or NULL
* if the category is the root category.
* @return the parent category.
**/
virtual Category* getParent() throw();
/**
* Returns the parent category of this category, or NULL
* if the category is the root category.
* @return the parent category.
**/
virtual const Category* getParent() const throw();
/**
* Log a message with the specified priority.
* @param priority The priority of this log message.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
virtual void log(Priority::Value priority, const char* stringFormat,
...) throw();
/**
* Log a message with the specified priority.
* @param priority The priority of this log message.
* @param message string to write in the log file
**/
virtual void log(Priority::Value priority,
const std::string& message) throw();
/**
* Log a message with the specified priority.
* @since 0.2.7
* @param priority The priority of this log message.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param va The arguments for stringFormat.
**/
virtual void logva(Priority::Value priority,
const char* stringFormat,
va_list va) throw();
/**
* Log a message with debug priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void debug(const char* stringFormat, ...) throw();
/**
* Log a message with debug priority.
* @param message string to write in the log file
**/
void debug(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority DEBUG.
* @returns Whether the Category will log.
**/
inline bool isDebugEnabled() const throw() {
return isPriorityEnabled(Priority::DEBUG);
};
/**
* Return a CategoryStream with priority DEBUG.
* @returns The CategoryStream.
**/
inline CategoryStream debugStream() {
return getStream(Priority::DEBUG);
}
/**
* Log a message with info priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void info(const char* stringFormat, ...) throw();
/**
* Log a message with info priority.
* @param message string to write in the log file
**/
void info(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority INFO.
* @returns Whether the Category will log.
**/
inline bool isInfoEnabled() const throw() {
return isPriorityEnabled(Priority::INFO);
};
/**
* Return a CategoryStream with priority INFO.
* @returns The CategoryStream.
**/
inline CategoryStream infoStream() {
return getStream(Priority::INFO);
}
/**
* Log a message with notice priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void notice(const char* stringFormat, ...) throw();
/**
* Log a message with notice priority.
* @param message string to write in the log file
**/
void notice(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority NOTICE.
* @returns Whether the Category will log.
**/
inline bool isNoticeEnabled() const throw() {
return isPriorityEnabled(Priority::NOTICE);
};
/**
* Return a CategoryStream with priority NOTICE.
* @returns The CategoryStream.
**/
inline CategoryStream noticeStream() {
return getStream(Priority::NOTICE);
}
/**
* Log a message with warn priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void warn(const char* stringFormat, ...) throw();
/**
* Log a message with warn priority.
* @param message string to write in the log file
**/
void warn(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority WARN.
* @returns Whether the Category will log.
**/
inline bool isWarnEnabled() const throw() {
return isPriorityEnabled(Priority::WARN);
};
/**
* Return a CategoryStream with priority WARN.
* @returns The CategoryStream.
**/
inline CategoryStream warnStream() {
return getStream(Priority::WARN);
};
/**
* Log a message with error priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void error(const char* stringFormat, ...) throw();
/**
* Log a message with error priority.
* @param message string to write in the log file
**/
void error(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority ERROR.
* @returns Whether the Category will log.
**/
inline bool isErrorEnabled() const throw() {
return isPriorityEnabled(Priority::ERROR);
};
/**
* Return a CategoryStream with priority ERROR.
* @returns The CategoryStream.
**/
inline CategoryStream errorStream() {
return getStream(Priority::ERROR);
};
/**
* Log a message with crit priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void crit(const char* stringFormat, ...) throw();
/**
* Log a message with crit priority.
* @param message string to write in the log file
**/
void crit(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority CRIT.
* @returns Whether the Category will log.
**/
inline bool isCritEnabled() const throw() {
return isPriorityEnabled(Priority::CRIT);
};
/**
* Return a CategoryStream with priority CRIT.
* @returns The CategoryStream.
**/
inline CategoryStream critStream() {
return getStream(Priority::CRIT);
};
/**
* Log a message with alert priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void alert(const char* stringFormat, ...) throw();
/**
* Log a message with alert priority.
* @param message string to write in the log file
**/
void alert(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority ALERT.
* @returns Whether the Category will log.
**/
inline bool isAlertEnabled() const throw() {
return isPriorityEnabled(Priority::ALERT);
};
/**
* Return a CategoryStream with priority ALERT.
* @returns The CategoryStream.
**/
inline CategoryStream alertStream() throw() {
return getStream(Priority::ALERT);
};
/**
* Log a message with emerg priority.
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void emerg(const char* stringFormat, ...) throw();
/**
* Log a message with emerg priority.
* @param message string to write in the log file
**/
void emerg(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority EMERG.
* @returns Whether the Category will log.
**/
inline bool isEmergEnabled() const throw() {
return isPriorityEnabled(Priority::EMERG);
};
/**
* Return a CategoryStream with priority EMERG.
* @returns The CategoryStream.
**/
inline CategoryStream emergStream() {
return getStream(Priority::EMERG);
};
/**
* Log a message with fatal priority.
* NB. priority 'fatal' is equivalent to 'emerg'.
* @since 0.2.7
* @param stringFormat Format specifier for the string to write
* in the log file.
* @param ... The arguments for stringFormat
**/
void fatal(const char* stringFormat, ...) throw();
/**
* Log a message with fatal priority.
* NB. priority 'fatal' is equivalent to 'emerg'.
* @since 0.2.7
* @param message string to write in the log file
**/
void fatal(const std::string& message) throw();
/**
* Return true if the Category will log messages with priority FATAL.
* NB. priority 'fatal' is equivalent to 'emerg'.
* @since 0.2.7
* @returns Whether the Category will log.
**/
inline bool isFatalEnabled() const throw() {
return isPriorityEnabled(Priority::FATAL);
};
/**
* Return a CategoryStream with priority FATAL.
* NB. priority 'fatal' is equivalent to 'emerg'.
* @since 0.2.7
* @returns The CategoryStream.
**/
inline CategoryStream fatalStream() {
return getStream(Priority::FATAL);
};
/**
* Return a CategoryStream with given Priority.
* @param priority The Priority of the CategoryStream.
* @returns The requested CategoryStream.
**/
virtual CategoryStream getStream(Priority::Value priority);
/**
* Return a CategoryStream with given Priority.
* @param priority The Priority of the CategoryStream.
* @returns The requested CategoryStream.
**/
virtual CategoryStream operator<<(Priority::Value priority);
protected:
/**
* Constructor
* @param name the fully qualified name of this Category
* @param parent the parent of this parent, or NULL for the root
* Category
* @param priority the priority for this Category. Defaults to
* Priority::NOTSET
**/
Category(const std::string& name, Category* parent,
Priority::Value priority = Priority::NOTSET);
virtual void _logUnconditionally(Priority::Value priority,
const char* format,
va_list arguments) throw();
/**
* Unconditionally log a message with the specified priority.
* @param priority The priority of this log message.
* @param message string to write in the log file
**/
virtual void _logUnconditionally2(Priority::Value priority,
const std::string& message) throw();
private:
/* prevent copying and assignment */
Category(const Category& other);
Category& operator=(const Category& other);
/** The name of this category. */
const std::string _name;
/**
* The parent of this category. All categories have al least one
* ancestor which is the root category.
**/
Category* _parent;
/**
* The assigned priority of this category.
**/
volatile Priority::Value _priority;
typedef std::map<Appender *, bool> OwnsAppenderMap;
/**
* Returns the iterator to the Appender if the Category owns the
* Appender. In that case the Category destructor will delete the
* Appender.
**/
virtual bool ownsAppender(Appender* appender,
OwnsAppenderMap::iterator& i2) throw();
AppenderSet _appender;
mutable threading::Mutex _appenderSetMutex;
/**
* Whether the category holds the ownership of the appender. If so,
* it deletes the appender in its destructor.
**/
OwnsAppenderMap _ownsAppender;
/**
* Additivity is set to true by default, i.e. a child inherits its
* ancestor's appenders by default.
*/
volatile bool _isAdditive;
};
}
#endif // _LOG4SHIB_CATEGORY_HH
|