Skip to content

Commit 5e69e9e

Browse files
author
Jan Wilmans
committed
removed comments and updated readme
1 parent dca1080 commit 5e69e9e

File tree

2 files changed

+55
-56
lines changed

2 files changed

+55
-56
lines changed

README.md

Lines changed: 54 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
Debugview++ v1.9.x.x (2025 Update coming soon!)
2-
------------------------------
3-
- Noteworthy new features: capture kernel messages, verbose mode and pass-through mode.
1+
## Contact information
42

5-
-- Notice:
3+
![Discord](https://discordapp.com/users/456038206987567105)
4+
![Mastodon Follow](https://img.shields.io/mastodon/follow/109524813797978857?domain=https%3A%2F%2Ftoot.community&style=social)
5+
![Github Follow](https://img.shields.io/github/followers/janwilmans)
66

7-
* This project is in low-maintenance mode, this means new features are only added if PRs are provided with tests.
8-
* Updates are limited to keeping the status-quo and OS-related updated.
9-
* I'm looking for maintainers, so if you would like to join me in bugfixing or adding features, please let me know.
10-
* 2022 update: The project was migrated to VS2022 and boost 1.80, WindowsXP (32 bit) support was removed.
11-
* the OutputForwarder companion extension for VS2022 can be found in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=JanWilmans.OutputForwarder2022)
12-
* nuget.exe can be downloaded from https://www.nuget.org/downloads
7+
## Debugview++ v1.20.x.x (Summer 2025 Update coming soon!)
138

14-
Debugview++, currently at v1.9 (2024 Update!)
15-
------------------------------
9+
- new features: capture kernel messages, verbose mode and pass-through mode, big thanks to x64bugreport and 593749519 for providing information, contributions and test scenarios.
10+
- fixed #365: support for messages from UWP applications (poorly tested), feedback welcome!
11+
- fixed #396: depending on the runtime dlls, this broke when we moved to cmake, now we link the runtime statically again.
12+
- fixed title bar not being updated when 'Global Win32' was toggled.
13+
- new commandline argument /tab:<name> to select a tab that get focus at startup, contributed by KirisameMarisa
14+
- removed color support from 'include' filter by request (a highlight filter can still achieve the same result), contributed by Ishmaeel.
15+
- faster building by adding /MP.
1616

17-
![Mastodon Follow](https://img.shields.io/mastodon/follow/109524813797978857?domain=https%3A%2F%2Ftoot.community&style=social)
18-
![Github Follow](https://img.shields.io/github/followers/janwilmans)
17+
-- Notice:
18+
19+
- This project is in low-maintenance mode, this means new features are only added if PRs are provided with tests.
20+
- Updates are limited to keeping the status-quo and OS-related updated.
21+
- I'm looking for maintainers, so if you would like to join me in bugfixing or adding features, please let me know.
22+
- 2022 update: The project was migrated to VS2022 and boost 1.80, WindowsXP (32 bit) support was removed.
23+
- the OutputForwarder companion extension for VS2022 can be found in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=JanWilmans.OutputForwarder2022)
24+
- nuget.exe can be downloaded from https://www.nuget.org/downloads
25+
26+
## Debugview++, currently at v1.9 (2024 Update!)
1927

2028
[![All Releases](https://img.shields.io/github/downloads/CobaltFusion/DebugViewPP/total.svg)](https://github.com/CobaltFusion/DebugViewPP/releases/latest)
2129
[![Current Release](https://img.shields.io/github/downloads/CobaltFusion/DebugViewPP/latest/total.svg)](https://github.com/CobaltFusion/DebugViewPP/releases/latest)
@@ -32,6 +40,7 @@ There is also a [slack channel](https://cpplang.slack.com/messages/debugviewpp).
3240

3341
Debugview++ started as a viewer for Win32 OutputDebugString messages in the style of
3442
Sysinternals DebugView. However, it can now be attached to virtually any other kind of logging, such as:
43+
3544
- tailing ascii and UTF logfiles (just drag it onto the window)
3645
- Android ADB (or any console based standard output)
3746
- serial ports (using plink)
@@ -40,31 +49,30 @@ Sysinternals DebugView. However, it can now be attached to virtually any other k
4049

4150
See examples down below.
4251

43-
Sponsors
44-
--------
52+
## Sponsors
4553

4654
This project is sponsored by:
4755

4856
[![Resharper logo](art/resharpercpp_logo.png)](https://www.jetbrains.com/)
4957

5058
Build in code analysis, handy auto-fixes and refactoring options
5159

52-
[![Backtrace logo](art/backtrace_logo.png)](https://backtrace.io/ )
60+
[![Backtrace logo](art/backtrace_logo.png)](https://backtrace.io/)
5361

5462
Gather and analyse crash information.
5563

5664
[![Incredibuild logo](art/incredi_logo.png)](https://www.incredibuild.com/)
5765

5866
We use Incredibuild to make use of all cores of multiple machines to accelerate building our C++ projects.
5967

60-
So when is this Debugview++ thing useful?
61-
------------------------------------------
68+
## So when is this Debugview++ thing useful?
6269

6370
- first of all, with debugview++ you can see messages from different processes, not just 'attached' processes.
6471
- also: filtering, coloring and linking. To make sense of a large amount of information humans need to filter it or order it understand it. Also it helps if important events have different colors to quickly interpret the occurring patterns.
6572
- finally, filtering is nice, but sometimes you need to see a line in its context to understand it, this is where linked views can help to quickly switch between a fully filtered view and a fully detailed view.
6673

6774
New in stable version 1.8.x:
75+
6876
- bugfixes (namely in file-tailing)
6977
- tested on windows 10
7078
- last version with (official) XP support (v141_xp target)
@@ -74,23 +82,25 @@ New in stable version 1.8.x:
7482
- no other new features planned, if you're missing something you need, file an issue!
7583

7684
Features we dream about and will create when we choose to spend the time:
85+
7786
- a gantt chart-like view, a horizontal timeline, with bars/flags/signs on it to identify events
7887
- a better plugin based input system
7988
- transparent background streaming to disk
8089
- proper memory limits
8190

8291
Known issues:
92+
8393
- the history limit doesn't work right, this is troublesome for long-running duration-tests.
8494
A workaround is to send 'DBGVIEWCLEAR' before each test-cycle (this clears all logs from memory).
8595
- there is no 'pass-through' mode like the original dbgview had, if you can help me implement this, please contact me.
8696
- same goes for catching kernel messages, help wanted.
8797

88-
References
89-
----------
90-
[OutputDebugString on MSDN](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363362(v=vs.85).aspx)
98+
## References
99+
100+
[OutputDebugString on MSDN](<https://msdn.microsoft.com/en-us/library/windows/desktop/aa363362(v=vs.85).aspx>)
101+
102+
## Screenshot
91103

92-
Screenshot
93-
-----------
94104
![DebugView++ Screenshot](art/syntax_high.png "DebugView++ Screenshot")
95105

96106
Here are some features:
@@ -128,18 +138,18 @@ And more features:
128138
- View->Process Colors, easy way to give every process its own color!
129139
- Options->Link views, best effort to synchronize the line-selection over all views
130140

131-
Download old version (stable, dated 20 Sept 2015)
132-
-----------------------
133-
+ [DebugView v1.5.x Zipped executables](https://github.com/CobaltFusion/DebugViewPP/files/1408599/DebugView.v1.5.zip)
134-
+ [DebugView v1.5.x Win32 installer](https://github.com/CobaltFusion/DebugViewPP/files/1408607/DebugView.v1.5_msi.zip)
141+
## Download old version (stable, dated 20 Sept 2015)
142+
143+
- [DebugView v1.5.x Zipped executables](https://github.com/CobaltFusion/DebugViewPP/files/1408599/DebugView.v1.5.zip)
144+
- [DebugView v1.5.x Win32 installer](https://github.com/CobaltFusion/DebugViewPP/files/1408607/DebugView.v1.5_msi.zip)
135145

136146
Screenshot demonstrating bookmarks and highlighting features.
137147

138148
**Highlighted**:
139149

140-
- regex (token filter): ``[^\s]*\\[\\\w+\.\s]+`` filenames in blue
141-
- regex (token filter): ``0x\w+`` hexadecimal numbers in red
142-
- regex (highlight filter): ``Unittest`` lines with the word 'Unittest' have a lightgreen background
150+
- regex (token filter): `[^\s]*\\[\\\w+\.\s]+` filenames in blue
151+
- regex (token filter): `0x\w+` hexadecimal numbers in red
152+
- regex (highlight filter): `Unittest` lines with the word 'Unittest' have a lightgreen background
143153
- a doubleclick on 'bytes' causes all instances of 'bytes' to highlight in yellow
144154

145155
See http://www.cplusplus.com/reference/regex/ECMAScript/ for all options for supported regular expressions
@@ -150,16 +160,15 @@ See http://www.cplusplus.com/reference/regex/ECMAScript/ for all options for sup
150160

151161
Screenshot demonstrating connecting to ADB logcat (Android Debug Bridge)
152162

153-
More examples
154-
-------------
163+
## More examples
155164

156165
**Connect any pipe**:
157166

158167
To connect directly to a port or service, [plink] can be used, make sure an instance of debugview++ is already running before running this command:
159168

160169
> plink -ssh -batch -v 192.168.0.1 2>&1 | debugview++
161170
162-
Notice that 2>&1 is used *before* the pipe (|) symbol to redirect stderr to stdout.
171+
Notice that 2>&1 is used _before_ the pipe (|) symbol to redirect stderr to stdout.
163172

164173
[plink]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
165174

@@ -170,18 +179,16 @@ And connect DebugView++ using Log->Connect DebugView Agent. Note that 'Log->Conn
170179

171180
**Use RegexGroups + Token Highlighting**:
172181

173-
Suppose you want to highlight some data value in your logging, since the actually value may differ, you cannot use normal matching to highlight them. With RegexGroups you can match text _before_ or _after the actual token you want to highlight.
182+
Suppose you want to highlight some data value in your logging, since the actually value may differ, you cannot use normal matching to highlight them. With RegexGroups you can match text _before_ or \_after the actual token you want to highlight.
174183

175184
Example:
176185

177186
![FilterDialog Screenshot](art/regexgroups.png "RegexGroups Screenshot")
178187

179-
Filters:
180-
--------
188+
## Filters:
181189

182190
![FilterDialog Screenshot](art/filterdialog.png "FilterDialog Screenshot")
183191

184-
185192
Filters can be defined per view, for example choose File -> New View, and the filter dialog will popup.
186193
Pressing OK will open a new view without any filters.
187194

@@ -199,18 +206,18 @@ just type any word or part of a word to match.
199206
- stop: if a matching expression is found autoscroll is turned off, all track filters will be disabled and the line is focused. Note: stop filters work only if autoscroll is on, think of a stop-filter as a single-shot track filter
200207
- beep: a standard windows beep (configurable in config panel->sounds) is played
201208

202-
*Practical uses*:
209+
_Practical uses_:
203210

204211
Include, exclude, once and highlight filters are the most intuitive filters to use. Track and stop can be a little confusing, let me try to give some examples.
205212

206213
**track**: use this filter to focus interesting lines that do not occur very often, but at a regular interval, for example, so you are monitoring a process that logs output every 30 seconds and you need to check the result.
207214

208215
**stop**: this filter is good when some special event occurs (an exception?) and you want to inspect the context of the event in the log before continuing. A press of the 'end' button will resume auto scrolling.
209216

210-
Other features:
211-
----------------
217+
## Other features:
212218

213219
**views**:
220+
214221
- reset view; make the first line in the logbuffer the first line in the view
215222
- reset view to this line; make the current like the first line in the view
216223
- clear view; make next incoming message the first line in the view
@@ -227,8 +234,7 @@ Now you can monitor the filtered view, and when your event occurs, select a line
227234

228235
**process colors**: If enabled each process (even processed with identical names) will get a its own background color automatically without adding any filters.
229236

230-
Other documentation:
231-
--------------------
237+
## Other documentation:
232238

233239
**Auto Scroll**: scrolls down to new incoming lines automatically
234240

@@ -239,11 +245,12 @@ turned off if any other line is selected.
239245

240246
**ClockTime**: when enabled the time is displayed as provided by the system's real-time clock (RTC). Such a timestamp has a 16ms resolution on a typical desktop PC. When disabled, time is displayed as a relative time to the first message, however this timestamp is obtained from the High-Performance Counter (HPC) which typically has a sub-microsecond resolution.
241247

242-
The resolution should not be confused with accuracy here, the recorded timestamp is not the actual time the message occurred, it is the time the message was received by DebugView++. Also there is no guarantee that the time between occurrence and reception of messages is constant, *however* in practice this is **pretty** constant :)
248+
The resolution should not be confused with accuracy here, the recorded timestamp is not the actual time the message occurred, it is the time the message was received by DebugView++. Also there is no guarantee that the time between occurrence and reception of messages is constant, _however_ in practice this is **pretty** constant :)
249+
250+
## How to build
243251

244-
How to build
245-
------------
246252
This project has a special configuration:
253+
247254
- 32bit debug/release configurations are targeted to v140_XP, SDK v7.0 (windows XP SP3 and up)
248255
- 64bit debug/release configurations are targeted to v141, SDK v8.1 (runs on windows 7 and up)
249256
- only the release configurations also build the Wix installer
@@ -265,7 +272,7 @@ Since we use ATL and support Windows XP still some extra installation options ar
265272
![VS2017 Option screen](art/vs2017_options.png "VS2017 Option screen")
266273

267274
- zip.exe, http://gnuwin32.sourceforge.net/packages/zip.htm, choose [zip-3.0-setup.exe]
268-
decompress the archive and you're done (add zip.exe to the path)
275+
decompress the archive and you're done (add zip.exe to the path)
269276

270277
# VS2019
271278

@@ -279,4 +286,3 @@ mailto:janwilmans _at_ gmail.com
279286

280287
Gert-Jan de Vos
281288
282-

application/DebugViewppLib/DBWinReader.cpp

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,11 @@ DBWinReader::DBWinReader(Timer& timer, ILineBuffer& linebuffer, bool global) :
4242
{
4343
SetDescription(global ? L"Global Win32 Messages" : L"Win32 Messages");
4444

45-
//Option 1:
45+
// required permissions for messages from UWP applications
4646
Win32::AdjustObjectDACL(m_hBuffer.get());
4747
Win32::AdjustObjectDACL(m_dbWinBufferReady.get());
4848
Win32::AdjustObjectDACL(m_dbWinDataReady.get());
4949

50-
//Option 2:
51-
//Win32::DeleteObjectDACL(m_hBuffer.get());
52-
//Win32::DeleteObjectDACL(m_dbWinBufferReady.get());
53-
//Win32::DeleteObjectDACL(m_dbWinDataReady.get());
54-
55-
// TODO(jan): Please test this and choose one
56-
5750
Win32::SetEvent(m_dbWinBufferReady);
5851
}
5952

0 commit comments

Comments
 (0)