/usr/share/doc/libjuce/apiref/classFileLogger.html is in libjuce-doc 4.3.0~repack-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: FileLogger Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classFileLogger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileLogger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A simple implementation of a <a class="el" href="classLogger.html" title="Acts as an application-wide logging class. ">Logger</a> that writes to a file.
<a href="classFileLogger.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FileLogger:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classFileLogger.png" usemap="#FileLogger_map" alt=""/>
<map id="FileLogger_map" name="FileLogger_map">
<area href="classLogger.html" title="Acts as an application-wide logging class. " alt="Logger" shape="rect" coords="0,0,73,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a708694692a4ab44a1436c8a55e6549f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#a708694692a4ab44a1436c8a55e6549f2">FileLogger</a> (const <a class="el" href="classFile.html">File</a> &fileToWriteTo, const <a class="el" href="classString.html">String</a> &welcomeMessage, const <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> maxInitialFileSizeBytes=128 *1024)</td></tr>
<tr class="memdesc:a708694692a4ab44a1436c8a55e6549f2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classFileLogger.html" title="A simple implementation of a Logger that writes to a file. ">FileLogger</a> for a given file. <a href="#a708694692a4ab44a1436c8a55e6549f2">More...</a><br /></td></tr>
<tr class="separator:a708694692a4ab44a1436c8a55e6549f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab08af44f2de3fe1b51158132f9a399dd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#ab08af44f2de3fe1b51158132f9a399dd">~FileLogger</a> ()</td></tr>
<tr class="memdesc:ab08af44f2de3fe1b51158132f9a399dd"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab08af44f2de3fe1b51158132f9a399dd">More...</a><br /></td></tr>
<tr class="separator:ab08af44f2de3fe1b51158132f9a399dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2dae5bcd0746287b8c5076019ea741c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classFile.html">File</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#aa2dae5bcd0746287b8c5076019ea741c">getLogFile</a> () const noexcept</td></tr>
<tr class="memdesc:aa2dae5bcd0746287b8c5076019ea741c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file that this logger is writing to. <a href="#aa2dae5bcd0746287b8c5076019ea741c">More...</a><br /></td></tr>
<tr class="separator:aa2dae5bcd0746287b8c5076019ea741c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf1bc4062f89bc56c9926bb1af268bb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#aaf1bc4062f89bc56c9926bb1af268bb4">logMessage</a> (const <a class="el" href="classString.html">String</a> &)</td></tr>
<tr class="memdesc:aaf1bc4062f89bc56c9926bb1af268bb4"><td class="mdescLeft"> </td><td class="mdescRight">This is overloaded by subclasses to implement custom logging behaviour. <a href="#aaf1bc4062f89bc56c9926bb1af268bb4">More...</a><br /></td></tr>
<tr class="separator:aaf1bc4062f89bc56c9926bb1af268bb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classLogger')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classLogger.html">Logger</a></td></tr>
<tr class="memitem:ae93f62ca3e47716b7120acb032a260f3 inherit pub_methods_classLogger"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#ae93f62ca3e47716b7120acb032a260f3">~Logger</a> ()</td></tr>
<tr class="memdesc:ae93f62ca3e47716b7120acb032a260f3 inherit pub_methods_classLogger"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classLogger.html#ae93f62ca3e47716b7120acb032a260f3">More...</a><br /></td></tr>
<tr class="separator:ae93f62ca3e47716b7120acb032a260f3 inherit pub_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6ddf300bd192744a4767fc88a78b2dd9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classFileLogger.html">FileLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#a6ddf300bd192744a4767fc88a78b2dd9">createDefaultAppLogger</a> (const <a class="el" href="classString.html">String</a> &logFileSubDirectoryName, const <a class="el" href="classString.html">String</a> &logFileName, const <a class="el" href="classString.html">String</a> &welcomeMessage, const <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> maxInitialFileSizeBytes=128 *1024)</td></tr>
<tr class="memdesc:a6ddf300bd192744a4767fc88a78b2dd9"><td class="mdescLeft"> </td><td class="mdescRight">Helper function to create a log file in the correct place for this platform. <a href="#a6ddf300bd192744a4767fc88a78b2dd9">More...</a><br /></td></tr>
<tr class="separator:a6ddf300bd192744a4767fc88a78b2dd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6278d0c047edb99196e6fa1c72bc91f5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classFileLogger.html">FileLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#a6278d0c047edb99196e6fa1c72bc91f5">createDateStampedLogger</a> (const <a class="el" href="classString.html">String</a> &logFileSubDirectoryName, const <a class="el" href="classString.html">String</a> &logFileNameRoot, const <a class="el" href="classString.html">String</a> &logFileNameSuffix, const <a class="el" href="classString.html">String</a> &welcomeMessage)</td></tr>
<tr class="memdesc:a6278d0c047edb99196e6fa1c72bc91f5"><td class="mdescLeft"> </td><td class="mdescRight">Helper function to create a log file in the correct place for this platform. <a href="#a6278d0c047edb99196e6fa1c72bc91f5">More...</a><br /></td></tr>
<tr class="separator:a6278d0c047edb99196e6fa1c72bc91f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addb33c331b16dca4b732558b44c1fab7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classFile.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#addb33c331b16dca4b732558b44c1fab7">getSystemLogFileFolder</a> ()</td></tr>
<tr class="memdesc:addb33c331b16dca4b732558b44c1fab7"><td class="mdescLeft"> </td><td class="mdescRight">Returns an OS-specific folder where log-files should be stored. <a href="#addb33c331b16dca4b732558b44c1fab7">More...</a><br /></td></tr>
<tr class="separator:addb33c331b16dca4b732558b44c1fab7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0224c141681c9fd2ec850aed189b65f8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileLogger.html#a0224c141681c9fd2ec850aed189b65f8">trimFileSize</a> (const <a class="el" href="classFile.html">File</a> &file, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> maxFileSize)</td></tr>
<tr class="memdesc:a0224c141681c9fd2ec850aed189b65f8"><td class="mdescLeft"> </td><td class="mdescRight">This is a utility function which removes lines from the start of a text file to make sure that its total size is below the given size. <a href="#a0224c141681c9fd2ec850aed189b65f8">More...</a><br /></td></tr>
<tr class="separator:a0224c141681c9fd2ec850aed189b65f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classLogger')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classLogger.html">Logger</a></td></tr>
<tr class="memitem:a5855a0341fc4f6ceb5418879fd685277 inherit pub_static_methods_classLogger"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277">setCurrentLogger</a> (<a class="el" href="classLogger.html">Logger</a> *newLogger) noexcept</td></tr>
<tr class="memdesc:a5855a0341fc4f6ceb5418879fd685277 inherit pub_static_methods_classLogger"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current logging class to use. <a href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277">More...</a><br /></td></tr>
<tr class="separator:a5855a0341fc4f6ceb5418879fd685277 inherit pub_static_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4646bc85614d9cfe225f1f89bca50c74 inherit pub_static_methods_classLogger"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classLogger.html">Logger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a4646bc85614d9cfe225f1f89bca50c74">getCurrentLogger</a> () noexcept</td></tr>
<tr class="memdesc:a4646bc85614d9cfe225f1f89bca50c74 inherit pub_static_methods_classLogger"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current logger, or nullptr if none has been set. <a href="classLogger.html#a4646bc85614d9cfe225f1f89bca50c74">More...</a><br /></td></tr>
<tr class="separator:a4646bc85614d9cfe225f1f89bca50c74 inherit pub_static_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a037cd16034c0663805f301b0e95c0be6 inherit pub_static_methods_classLogger"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a037cd16034c0663805f301b0e95c0be6">writeToLog</a> (const <a class="el" href="classString.html">String</a> &message)</td></tr>
<tr class="memdesc:a037cd16034c0663805f301b0e95c0be6 inherit pub_static_methods_classLogger"><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to the current logger. <a href="classLogger.html#a037cd16034c0663805f301b0e95c0be6">More...</a><br /></td></tr>
<tr class="separator:a037cd16034c0663805f301b0e95c0be6 inherit pub_static_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54273b4faf398b4da464d21bb6abac59 inherit pub_static_methods_classLogger"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a54273b4faf398b4da464d21bb6abac59">outputDebugString</a> (const <a class="el" href="classString.html">String</a> &text)</td></tr>
<tr class="memdesc:a54273b4faf398b4da464d21bb6abac59 inherit pub_static_methods_classLogger"><td class="mdescLeft"> </td><td class="mdescRight">Writes a message to the standard error stream. <a href="classLogger.html#a54273b4faf398b4da464d21bb6abac59">More...</a><br /></td></tr>
<tr class="separator:a54273b4faf398b4da464d21bb6abac59 inherit pub_static_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classLogger"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classLogger')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classLogger.html">Logger</a></td></tr>
<tr class="memitem:abc41bfb031d896170c7675fa96a6b30c inherit pro_methods_classLogger"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#abc41bfb031d896170c7675fa96a6b30c">Logger</a> ()</td></tr>
<tr class="separator:abc41bfb031d896170c7675fa96a6b30c inherit pro_methods_classLogger"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A simple implementation of a <a class="el" href="classLogger.html" title="Acts as an application-wide logging class. ">Logger</a> that writes to a file. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classLogger.html" title="Acts as an application-wide logging class. ">Logger</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a708694692a4ab44a1436c8a55e6549f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a708694692a4ab44a1436c8a55e6549f2">§ </a></span>FileLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileLogger::FileLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>fileToWriteTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>welcomeMessage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>maxInitialFileSizeBytes</em> = <code>128 *1024</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classFileLogger.html" title="A simple implementation of a Logger that writes to a file. ">FileLogger</a> for a given file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fileToWriteTo</td><td>the file that to use - new messages will be appended to the file. If the file doesn't exist, it will be created, along with any parent directories that are needed. </td></tr>
<tr><td class="paramname">welcomeMessage</td><td>when opened, the logger will write a header to the log, along with the current date and time, and this welcome message </td></tr>
<tr><td class="paramname">maxInitialFileSizeBytes</td><td>if this is zero or greater, then if the file already exists but is larger than this number of bytes, then the start of the file will be truncated to keep the size down. This prevents a log file getting ridiculously large over time. The file will be truncated at a new-line boundary. If this value is less than zero, no size limit will be imposed; if it's zero, the file will always be deleted. Note that the size is only checked once when this object is created - any logging that is done later will be appended without any checking </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab08af44f2de3fe1b51158132f9a399dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab08af44f2de3fe1b51158132f9a399dd">§ </a></span>~FileLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileLogger::~FileLogger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa2dae5bcd0746287b8c5076019ea741c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2dae5bcd0746287b8c5076019ea741c">§ </a></span>getLogFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classFile.html">File</a>& FileLogger::getLogFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the file that this logger is writing to. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>, and <a class="el" href="classLogger.html#ab2ef7f6552d425bf729b7d1a7ed5160f">Logger::logMessage()</a>.</p>
</div>
</div>
<a id="a6ddf300bd192744a4767fc88a78b2dd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ddf300bd192744a4767fc88a78b2dd9">§ </a></span>createDefaultAppLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classFileLogger.html">FileLogger</a>* FileLogger::createDefaultAppLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>logFileSubDirectoryName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>logFileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>welcomeMessage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>maxInitialFileSizeBytes</em> = <code>128 *1024</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function to create a log file in the correct place for this platform. </p>
<p>The method might return nullptr if the file can't be created for some reason.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">logFileSubDirectoryName</td><td>the name of the subdirectory to create inside the logs folder (as returned by getSystemLogFileFolder). It's best to use something like the name of your application here. </td></tr>
<tr><td class="paramname">logFileName</td><td>the name of the file to create, e.g. "MyAppLog.txt". </td></tr>
<tr><td class="paramname">welcomeMessage</td><td>a message that will be written to the log when it's opened. </td></tr>
<tr><td class="paramname">maxInitialFileSizeBytes</td><td>(see the <a class="el" href="classFileLogger.html" title="A simple implementation of a Logger that writes to a file. ">FileLogger</a> constructor for more info on this) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6278d0c047edb99196e6fa1c72bc91f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6278d0c047edb99196e6fa1c72bc91f5">§ </a></span>createDateStampedLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classFileLogger.html">FileLogger</a>* FileLogger::createDateStampedLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>logFileSubDirectoryName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>logFileNameRoot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>logFileNameSuffix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>welcomeMessage</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function to create a log file in the correct place for this platform. </p>
<p>The filename used is based on the root and suffix strings provided, along with a time and date string, meaning that a new, empty log file will be always be created rather than appending to an exising one.</p>
<p>The method might return nullptr if the file can't be created for some reason.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">logFileSubDirectoryName</td><td>the name of the subdirectory to create inside the logs folder (as returned by getSystemLogFileFolder). It's best to use something like the name of your application here. </td></tr>
<tr><td class="paramname">logFileNameRoot</td><td>the start of the filename to use, e.g. "MyAppLog_". This will have a timestamp and the logFileNameSuffix appended to it </td></tr>
<tr><td class="paramname">logFileNameSuffix</td><td>the file suffix to use, e.g. ".txt" </td></tr>
<tr><td class="paramname">welcomeMessage</td><td>a message that will be written to the log when it's opened. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="addb33c331b16dca4b732558b44c1fab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addb33c331b16dca4b732558b44c1fab7">§ </a></span>getSystemLogFileFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classFile.html">File</a> FileLogger::getSystemLogFileFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an OS-specific folder where log-files should be stored. </p>
<p>On Windows this will return a logger with a path such as: c:\Documents and Settings\username\Application Data\[logFileSubDirectoryName]\[logFileName]</p>
<p>On the Mac it'll create something like: ~/Library/Logs/[logFileSubDirectoryName]/[logFileName]</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileLogger.html#a6ddf300bd192744a4767fc88a78b2dd9" title="Helper function to create a log file in the correct place for this platform. ">createDefaultAppLogger</a> </dd></dl>
</div>
</div>
<a id="aaf1bc4062f89bc56c9926bb1af268bb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf1bc4062f89bc56c9926bb1af268bb4">§ </a></span>logMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void FileLogger::logMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is overloaded by subclasses to implement custom logging behaviour. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277" title="Sets the current logging class to use. ">setCurrentLogger</a> </dd></dl>
<p>Implements <a class="el" href="classLogger.html#ab2ef7f6552d425bf729b7d1a7ed5160f">Logger</a>.</p>
</div>
</div>
<a id="a0224c141681c9fd2ec850aed189b65f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0224c141681c9fd2ec850aed189b65f8">§ </a></span>trimFileSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void FileLogger::trimFileSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>maxFileSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is a utility function which removes lines from the start of a text file to make sure that its total size is below the given size. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__FileLogger_8h.html">juce_FileLogger.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|