<!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"/>
<title>Vidalia: CrashReporter.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a>
</div>
</div>
<div class="contents">
<h1>CrashReporter.h</h1><a href="_crash_reporter_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If you</span>
<a name="l00004"></a>00004 <span class="comment">** did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">** Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to the</span>
<a name="l00008"></a>00008 <span class="comment">** terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file CrashReporter.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id$</span>
<a name="l00014"></a>00014 <span class="comment">** \brief General routines to install a Breakpad-based exception handler and</span>
<a name="l00015"></a>00015 <span class="comment">** set options related to launching the crash reporting application.</span>
<a name="l00016"></a>00016 <span class="comment">*/</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef _CRASHREPORTER_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _CRASHREPORTER_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="keyword">class </span>QString;
<a name="l00022"></a>00022 <span class="keyword">class </span>QStringList;
<a name="l00023"></a>00023
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">namespace </span>CrashReporter
<a name="l00026"></a>00026 {<span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> /** Defines the maximum length of the absolute path plus filename of the</span>
<a name="l00028"></a>00028 <span class="comment"> * crash reporting executable displayed when the exception handler is</span>
<a name="l00029"></a>00029 <span class="comment"> * called.</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a>00031 <span class="preprocessor">#if defined(Q_OS_WIN32)</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespace_crash_reporter.html#a7ded4b9d077edc08bda77658c0a43f6d">MAX_PATH_LEN</a> = 260;
<a name="l00033"></a>00033 <span class="preprocessor">#else</span>
<a name="l00034"></a><a class="code" href="namespace_crash_reporter.html#a7ded4b9d077edc08bda77658c0a43f6d">00034</a> <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespace_crash_reporter.html#a7ded4b9d077edc08bda77658c0a43f6d">MAX_PATH_LEN</a> = 4096; <span class="comment">/* Is there a better value for this? */</span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** Defines the maximum length of the command line arguments used to restart</span>
<a name="l00038"></a>00038 <span class="comment"> * the crashed application by the crash reporter. The maximum command line</span>
<a name="l00039"></a>00039 <span class="comment"> * length is based on Windows' 32K character command line limit, according</span>
<a name="l00040"></a>00040 <span class="comment"> * to the MSDN documents.</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a><a class="code" href="namespace_crash_reporter.html#a0c1a7ebfa96cb383f0eb182ab490997c">00042</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespace_crash_reporter.html#a0c1a7ebfa96cb383f0eb182ab490997c">MAX_CMD_LEN</a> = 32768;
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /** Defines the maximum length of a build version string that can be set</span>
<a name="l00045"></a>00045 <span class="comment"> * by set_build_version().</span>
<a name="l00046"></a>00046 <span class="comment"> * \sa set_build_version()</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a><a class="code" href="namespace_crash_reporter.html#aa25b3b9073151dcfe6df941065d6914e">00048</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespace_crash_reporter.html#aa25b3b9073151dcfe6df941065d6914e">MAX_VERSION_LEN</a> = 64;
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> /** Installs the Breakpad exception handler and sets the static global</span>
<a name="l00051"></a>00051 <span class="comment"> * variables used by the exception handler to launch the crash reporting</span>
<a name="l00052"></a>00052 <span class="comment"> * application. Minidumps will be writen to <b>dumpPath</b>, which will</span>
<a name="l00053"></a>00053 <span class="comment"> * be created if it doesn't already exist.</span>
<a name="l00054"></a>00054 <span class="comment"> * \sa remove_exception_handler()</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="namespace_crash_reporter.html#a4cb74d71fc0972d3fdded194edf5ef6f">install_exception_handler</a>(<span class="keyword">const</span> QString &dumpPath);
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Removes the application's exception handler previously created by</span>
<a name="l00059"></a>00059 <span class="comment"> * install_exception_handler(). If no exception handler was previously created,</span>
<a name="l00060"></a>00060 <span class="comment"> * no action will be taken.</span>
<a name="l00061"></a>00061 <span class="comment"> * \sa install_exception_handler()</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="namespace_crash_reporter.html#a8c3f2a5d31dbc36bd7081e45394d09ec">remove_exception_handler</a>(<span class="keywordtype">void</span>);
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Sets <b>crashReporter</b> as the executable that gets called when the</span>
<a name="l00066"></a>00066 <span class="comment"> * exception handler catches a crash. If <b>crashReporter</b> contains one</span>
<a name="l00067"></a>00067 <span class="comment"> * or more spaces, the given path will be wrapped in quotes. The caller is</span>
<a name="l00068"></a>00068 <span class="comment"> * responsible for ensuring that <b>crashReporter</b> is no greater than</span>
<a name="l00069"></a>00069 <span class="comment"> * CrashReporter::MAX_PATH_LEN (including added quotes). Returns true if</span>
<a name="l00070"></a>00070 <span class="comment"> * the crash reporting application was set successfully, or false if</span>
<a name="l00071"></a>00071 <span class="comment"> * <b>crashReporter</b> was too long.</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> <a class="code" href="namespace_crash_reporter.html#a2abd2ccfcc795446372a6e01bb49711b">set_crash_reporter</a>(<span class="keyword">const</span> QString &crashReporter);
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** Sets the <b>executable</b> and <b>args</b> that will be passed to the</span>
<a name="l00076"></a>00076 <span class="comment"> * crash reporting application, so it can restart the crashed application</span>
<a name="l00077"></a>00077 <span class="comment"> * with the same arguments as before it crashed. If the <b>executable</b></span>
<a name="l00078"></a>00078 <span class="comment"> * path or any of <b>args</b> contains a space, they will be quoted before</span>
<a name="l00079"></a>00079 <span class="comment"> * being passed to the crash reporting application. The path to the</span>
<a name="l00080"></a>00080 <span class="comment"> * generated minidump, crash reporting application, executable to restart</span>
<a name="l00081"></a>00081 <span class="comment"> * and any arguments must fit within MAX_CMD_LEN, including any added</span>
<a name="l00082"></a>00082 <span class="comment"> * quotes.</span>
<a name="l00083"></a>00083 <span class="comment"> * \sa set_crash_reporter()</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> <a class="code" href="namespace_crash_reporter.html#ac9f4cdac9b824b9d9f44fa3c9b6151d8">set_restart_options</a>(<span class="keyword">const</span> QString &executable,
<a name="l00086"></a>00086 <span class="keyword">const</span> QStringList &arguments);
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /** Sets <b>version</b> as the build version identifier written to the</span>
<a name="l00089"></a>00089 <span class="comment"> * extra information file alongside a minidump. The version string must</span>
<a name="l00090"></a>00090 <span class="comment"> * be no longer than CrashReporter::MAX_VERSION_LEN.</span>
<a name="l00091"></a>00091 <span class="comment"> */</span>
<a name="l00092"></a>00092 <span class="keywordtype">bool</span> <a class="code" href="namespace_crash_reporter.html#a1eca6858cc79eb2d3b50ea0eba54c851">set_build_version</a>(<span class="keyword">const</span> QString &version);
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
109
