Precompiled headers - Revision history

Artojon: wikify

2006-07-10T11:10:57Z

wikify

← Older revision		Revision as of 11:10, 10 July 2006
Line 1:		Line 1:
	[[Category:User Documentation]]		[[Category:User Documentation]]
	~~Are you tired~~ of ~~waiting until~~ your project'~~s compilation finishes?~~		Using '''precompiled headers''' (or '''PCH''') speeds up the compilation of large projects (like Code::Blocks itself) by large amounts. This works by creating a header file which #includes all the rarely-changing header files for your project. Then the compiler is instructed to pre-compile this header file. This creates a new file which is now in a binary format that only the compiler understands. But, since it doesn't have to re-parse your header files for every source file that includes them, the process will now be considerably faster.
	~~Are you using huge libraries~~ for ~~your project (like wxWidgets)?~~

	~~If you answered yes above, then you 'd be happy to know that Code::Blocks, as of version 1.0rc2, supports precompiled headers for the GCC compiler.~~		==Creating a precompiled header==

	~~Using precompiled headers (PCH from now on) speeds up the compilation of large projects (like Code::Blocks itself) by large amounts.~~
	This works by creating a header file which #includes all the rarely-changing header files for your project. Then the compiler is instructed to pre-compile this header file. This creates a new file which is now in a binary format that only the compiler understands. But, since it doesn't have to re-parse your header files for every source file that includes them, the process will now be considerably faster ;)

	~~Enough ranting. Let's see step-by-step what you must do to create~~ a precompiled header ~~for your program.~~


	~~==Creating a precompiled header==~~
	To create a precompiled header for your project, just create a new header file.		To create a precompiled header for your project, just create a new header file.
	Say you named it "pch.h". Put the following in it:		Say you named it "pch.h". Put the following in it:
Line 46:		Line 38:
	</pre>		</pre>

			==Marking a header for precompilation==

	~~==Marking a header for precompilation==~~
	Now this file is ready to be marked as PCH. To do this, find the file in the ProjectManager tree, right-click on it and select "Properties".		Now this file is ready to be marked as PCH. To do this, find the file in the ProjectManager tree, right-click on it and select "Properties".

Line 53:		Line 45:

	Click "Compile file" and make sure it's checked.		Click "Compile file" and make sure it's checked.
	Do ~~<u>~~not~~</u>~~ click "Link file".
			Do '''not''' click "Link file".

	Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).		Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).
	Exit this dialog by clicking "OK".		Exit this dialog by clicking "OK".

	==Using a precompiled header==		==Using a precompiled header==

	You 're almost there. Only thing left is to actually include this file so that it can be used.		You 're almost there. Only thing left is to actually include this file so that it can be used.
	There are two ways to do this.		There are two ways to do this.
Line 67:		Line 62:
	-include "pch.h"		-include "pch.h"
	</pre>		</pre>

	The first line will emit a warning when building your project, if the PCH is _not_ used. It's nice to know this.		The first line will emit a warning when building your project, if the PCH is _not_ used. It's nice to know this.
	The second line, does all the magic: it's like adding <tt>#include "pch.h"</tt> at the top of each of your source files, except you don't have to edit them ;)
			The second line, does all the magic: it's like adding <tt>#include "pch.h"</tt> at the top of each of your source files, except you don't have to edit them.

	This doesn't work in all situations, but it's the quick way to add PCH in your project. Specifically, it won't work if the PCH is in the same directory as the project file. If that's the case, go to "Project->Properties" and set the PCH mode to "Generate PCH in a directory alongside the original file" (first option).		This doesn't work in all situations, but it's the quick way to add PCH in your project. Specifically, it won't work if the PCH is in the same directory as the project file. If that's the case, go to "Project->Properties" and set the PCH mode to "Generate PCH in a directory alongside the original file" (first option).

	~~I hope things are clearer now.~~
	~~Yiannis.~~

Artojon: remove extra category

2006-07-08T15:34:38Z

remove extra category

← Older revision		Revision as of 15:34, 8 July 2006
Line 1:		Line 1:
	~~[[Category:Application Development]]~~
	[[Category:User Documentation]]		[[Category:User Documentation]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?

Artojon: category fix

2006-07-08T15:07:28Z

category fix

← Older revision		Revision as of 15:07, 8 July 2006
Line 1:		Line 1:
	[[Category:Application Development]]		[[Category:Application Development]]
	[[Category:~~Development~~ Documentation]]		[[Category:User Documentation]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?
	Are you using huge libraries for your project (like wxWidgets)?		Are you using huge libraries for your project (like wxWidgets)?

Artojon: edited categories

2006-07-08T14:10:06Z

edited categories

← Older revision		Revision as of 14:10, 8 July 2006
Line 1:		Line 1:
	[[Category:Application Development]]		[[Category:Application Development]]
	[[Category:~~Code::Blocks~~ Development]]		[[Category:Development Documentation]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?
	Are you using huge libraries for your project (like wxWidgets)?		Are you using huge libraries for your project (like wxWidgets)?

Sethjackson at 20:47, 11 April 2006

2006-04-11T20:47:26Z

← Older revision		Revision as of 20:47, 11 April 2006
Line 1:		Line 1:
	[[~~Ctaegory~~:Application Development]]		[[Category:Application Development]]
	[[Category:Code::Blocks Development]]		[[Category:Code::Blocks Development]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?

Sethjackson at 20:45, 11 April 2006

2006-04-11T20:45:58Z

← Older revision		Revision as of 20:45, 11 April 2006
Line 1:		Line 1:
	[[~~Category~~:~~Code::Blocks features~~]]		[[Ctaegory:Application Development]]
	[[Category:Development]]		[[Category:Code::Blocks Development]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?
	Are you using huge libraries for your project (like wxWidgets)?		Are you using huge libraries for your project (like wxWidgets)?

Thomas at 15:22, 6 February 2006

2006-02-06T15:22:40Z

← Older revision		Revision as of 15:22, 6 February 2006
Line 1:		Line 1:
			[[Category:Code::Blocks features]]
			[[Category:Development]]
	Are you tired of waiting until your project's compilation finishes?		Are you tired of waiting until your project's compilation finishes?
	Are you using huge libraries for your project (like wxWidgets)?		Are you using huge libraries for your project (like wxWidgets)?

Mandrav: /* Marking a header for precompilation */

2005-12-14T19:14:28Z

Marking a header for precompilation

← Older revision		Revision as of 19:14, 14 December 2005
Line 52:		Line 52:

	Click "Compile file" and make sure it's checked.		Click "Compile file" and make sure it's checked.
	Do <u>not</u> click "Link file"		Do <u>not</u> click "Link file".
	Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).		Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).
	Exit this dialog by clicking "OK".		Exit this dialog by clicking "OK".

Mandrav: /* Using a precompiled header */

2005-12-14T19:14:02Z

Using a precompiled header

← Older revision		Revision as of 19:14, 14 December 2005
Line 60:		Line 60:
	There are two ways to do this.		There are two ways to do this.

	1) Include it in every source file of your project (_not_ header files, only source files like .cpp). This must* be the very first C token in the file. In other words, put it really first. Only comments are harmless before it.		# Include it in every source file of your project (_not_ header files, only source files like .cpp). This must* be the very first C token in the file. In other words, put it really first. Only comments are harmless before it.
			# Go to "Project->Build options" and add the following in "Compiler->Other options":
	2) Go to "Project->Build options" and add the following in "Compiler->Other options":
	<pre>		<pre>
	-Winvalid-pch		-Winvalid-pch

Mandrav: /* Marking a header for precompilation */

2005-12-14T19:13:15Z

Marking a header for precompilation

← Older revision		Revision as of 19:13, 14 December 2005
Line 52:		Line 52:

	Click "Compile file" and make sure it's checked.		Click "Compile file" and make sure it's checked.
	Do ~~_not_~~ click "Link file"		Do <u>not</u> click "Link file"
	Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).		Also, set the priority weight to zero, to force it to be compiled before all other files (default priority is 50 - the lower this number, the higher the priority).
	Exit this dialog by clicking "OK".		Exit this dialog by clicking "OK".


	==Using a precompiled header==		==Using a precompiled header==