Development/Tools/Automoc4 - Revision history

Neverendingo: /* Features */

2011-06-29T19:23:55Z

‎Features

Neverendingo: Text replace - "" to ""

2011-06-29T19:15:59Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T19:13:37Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 19:13, 29 June 2011
			
Line 57:
Line 57:
  This allows to do the following:   This allows to do the following:
  foo.h:   foo.h:
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  class A : public QObject {   class A : public QObject {
     Q_OBJECT      Q_OBJECT
Line 63:
Line 63:
  </code>   </code>
  foo.cpp:   foo.cpp:
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  class B : public QObject {   class B : public QObject {
     Q_OBJECT      Q_OBJECT



Mkretz: /* Features */
2008-08-17T15:38:46Z
‎Features

				
				
				
				
			
			← Older revision
			Revision as of 15:38, 17 August 2008
			
Line 57:
Line 57:
  This allows to do the following:   This allows to do the following:
  foo.h:   foo.h:
−  class A : public QObject { + <code cppqt>
−    Q_OBJECT + class A : public QObject {
−  }; +   Q_OBJECT
−   + };
  + </code>
  foo.cpp:   foo.cpp:
−  class B : public QObject { + <code cppqt>
−    Q_OBJECT + class B : public QObject {
−  }; +   Q_OBJECT
−  + };
−  #include "foo.moc" + 
−  #include "moc_foo.cpp" + 
    
  + #include "foo.moc"
  + #include "moc_foo.cpp"
  + </code>
  In that case two moc files will be created, moc_foo.cpp from foo.h and foo.moc from foo.cpp.   In that case two moc files will be created, moc_foo.cpp from foo.h and foo.moc from foo.cpp.
    





Mkretz: /* Features */
2008-08-17T15:37:20Z
‎Features

				
				
				
				
			
			← Older revision
			Revision as of 15:37, 17 August 2008
			
Line 57:
Line 57:
  This allows to do the following:   This allows to do the following:
  foo.h:   foo.h:
− class A : public QObject { +  class A : public QObject {
−   Q_OBJECT +    Q_OBJECT
− }; +  };
    
  foo.cpp:   foo.cpp:
− class B : public QObject { +  class B : public QObject {
−   Q_OBJECT +    Q_OBJECT
− }; +  };
−   +  
− #include "foo.moc" +  #include "foo.moc"
− #include "moc_foo.cpp" +  #include "moc_foo.cpp"
    
  In that case two moc files will be created, moc_foo.cpp from foo.h and foo.moc from foo.cpp.   In that case two moc files will be created, moc_foo.cpp from foo.h and foo.moc from foo.cpp.



Mkretz: /* Features */
2008-08-17T15:36:56Z
‎Features

				
				
				
				
			
			← Older revision
			Revision as of 15:36, 17 August 2008
			
Line 54:
Line 54:
  # ... it finds a line with #include "[<subdir>/]<filename>.moc" It then checks whether the source file containing the #include line contains a Q_OBJECT macro. If yes, then this source file will be used as source for the moc. If there's no Q_OBJECT macro in the source file it will use the first file of <current source dir>/<filename>.{h,hpp,hxx,H}, <current source dir>/<subdir>/<filename>.{h,hpp,hxx,H} that exists as source file for the moc. The output will go to <current binary dir>/<subdir>/<filename>.moc.   # ... it finds a line with #include "[<subdir>/]<filename>.moc" It then checks whether the source file containing the #include line contains a Q_OBJECT macro. If yes, then this source file will be used as source for the moc. If there's no Q_OBJECT macro in the source file it will use the first file of <current source dir>/<filename>.{h,hpp,hxx,H}, <current source dir>/<subdir>/<filename>.{h,hpp,hxx,H} that exists as source file for the moc. The output will go to <current binary dir>/<subdir>/<filename>.moc.
  # ... there is no moc #include line in the source file but an associated header file contains a Q_OBJECT macro. automoc4 will look for the first of <current source dir>/<source file basename>.{h,hpp,hxx,H} and the first of <current source dir>/<source file basename>_p.{h,hpp,hxx,H} whether they contain the Q_OBJECT macro. If one (or both) do then a moc file is created at <current binary dir>/moc_<source file basename>.cpp or <current binary dir>/moc_<source file basename>_p.cpp and the file(s) is/are then #included in the automoc_<target>.cpp file.   # ... there is no moc #include line in the source file but an associated header file contains a Q_OBJECT macro. automoc4 will look for the first of <current source dir>/<source file basename>.{h,hpp,hxx,H} and the first of <current source dir>/<source file basename>_p.{h,hpp,hxx,H} whether they contain the Q_OBJECT macro. If one (or both) do then a moc file is created at <current binary dir>/moc_<source file basename>.cpp or <current binary dir>/moc_<source file basename>_p.cpp and the file(s) is/are then #included in the automoc_<target>.cpp file.
  + 
  + This allows to do the following:
  + foo.h:
  + class A : public QObject {
  +   Q_OBJECT
  + };
  + 
  + foo.cpp:
  + class B : public QObject {
  +   Q_OBJECT
  + };
  + 
  + #include "foo.moc"
  + #include "moc_foo.cpp"
  + 
  + In that case two moc files will be created, moc_foo.cpp from foo.h and foo.moc from foo.cpp.
    
  ==When are which files generated==   ==When are which files generated==





Mkretz: /* Limitations */
2008-08-17T15:34:45Z
‎Limitations

				
				
				
				
			
			← Older revision
			Revision as of 15:34, 17 August 2008
			
Line 66:
Line 66:
    
  ==Limitations==   ==Limitations==
  + 
  + * The --touch hack does not work with nmake and requires an extra target to let automoc4 be called unconditionally. The extra target has the disadvantage that a make <target>/fast will not call automoc4.
  + * On all systems except with nmake, make <target>/fast will run automoc4 and with that keep the moc files up to date. The dependencies between source files and moc files are not guaranteed in this case so that it may be necessary to call make <target>/fast twice. This is not necessary if none of the source files contain a moc include (i.e. all moc files are included from automoc_<target>.cpp).
  + * If a file, included by a moc source file, changes such that the moc output will change one needs to either touch the moc source file or run make clean to force automoc4 to regenerate the moc file.



Mkretz: /* When are which files generated */
2008-08-17T15:29:52Z
‎When are which files generated

				
				
				
				
			
			← Older revision
			Revision as of 15:29, 17 August 2008
			
Line 56:
Line 56:
    
  ==When are which files generated==   ==When are which files generated==
  + 
  + automoc4 regenerates all moc files if
  + # the -D arguments have changed
  + # <current binary dir>/automoc_<target>.cpp does not exist
  + 
  + The latter is used by make clean to let all moc files be regenerated.
  + 
  + A single moc file is regenerated if the timestamp of its source file is newer than the timestamp of the generated moc file. It does '''not''' check for the timestamps of files included by the source.
    
  ==Limitations==   ==Limitations==





Mkretz: /* Features */
2008-08-17T15:24:57Z
‎Features

				
				
				
				
			
			← Older revision
			Revision as of 15:24, 17 August 2008
			
Line 48:
Line 48:
  ==Features==   ==Features==
    
− automoc4 is passed a list of files to process. For most cases this is a list of only source files (no headers) (i.e. the sources list variable used in the CMakeLists.txt file). It will then make sure a moc file is created if ... + automoc4 is passed a list of files to process. For most cases this is a list of only source files (no headers) (i.e. the sources list variable used in the CMakeLists.txt file).
− # ... it finds a line with #include "moc_<filename>.cpp" +  
− # ... it finds a line with #include "<filename>.moc" + A moc file is created if ...
− # ... it finds a Q_OBJECT macro in the header file, which's filepath it guesses from the filepath of the source file + # ... it finds a line with #include "[<subdir>/]moc_<filename>.cpp". In that case it will use the first file of <current source dir>/<filename>.{h,hpp,hxx,H}, <current source dir>/<subdir>/<filename>.{h,hpp,hxx,H} that exists as source file for the moc. The output will go to <current binary dir>/<subdir>/moc_<filename>.cpp.
  + # ... it finds a line with #include "[<subdir>/]<filename>.moc" It then checks whether the source file containing the #include line contains a Q_OBJECT macro. If yes, then this source file will be used as source for the moc. If there's no Q_OBJECT macro in the source file it will use the first file of <current source dir>/<filename>.{h,hpp,hxx,H}, <current source dir>/<subdir>/<filename>.{h,hpp,hxx,H} that exists as source file for the moc. The output will go to <current binary dir>/<subdir>/<filename>.moc.
  + # ... there is no moc #include line in the source file but an associated header file contains a Q_OBJECT macro. automoc4 will look for the first of <current source dir>/<source file basename>.{h,hpp,hxx,H} and the first of <current source dir>/<source file basename>_p.{h,hpp,hxx,H} whether they contain the Q_OBJECT macro. If one (or both) do then a moc file is created at <current binary dir>/moc_<source file basename>.cpp or <current binary dir>/moc_<source file basename>_p.cpp and the file(s) is/are then #included in the automoc_<target>.cpp file.
    
  ==When are which files generated==   ==When are which files generated==
    
  ==Limitations==   ==Limitations==



Mkretz: /* Features */
2008-08-17T14:59:14Z
‎Features

				
				
				
				
			
			← Older revision
			Revision as of 14:59, 17 August 2008
			
Line 47:
Line 47:
    
  ==Features==   ==Features==
  + 
  + automoc4 is passed a list of files to process. For most cases this is a list of only source files (no headers) (i.e. the sources list variable used in the CMakeLists.txt file). It will then make sure a moc file is created if ...
  + # ... it finds a line with #include "moc_<filename>.cpp"
  + # ... it finds a line with #include "<filename>.moc"
  + # ... it finds a Q_OBJECT macro in the header file, which's filepath it guesses from the filepath of the source file
    
  ==When are which files generated==   ==When are which files generated==
    
  ==Limitations==   ==Limitations==

← Older revision		Revision as of 15:34, 17 August 2008
Line 66:		Line 66:

	==Limitations==		==Limitations==
		+
		+	* The --touch hack does not work with nmake and requires an extra target to let automoc4 be called unconditionally. The extra target has the disadvantage that a make <target>/fast will not call automoc4.
		+	* On all systems except with nmake, make <target>/fast will run automoc4 and with that keep the moc files up to date. The dependencies between source files and moc files are not guaranteed in this case so that it may be necessary to call make <target>/fast twice. This is not necessary if none of the source files contain a moc include (i.e. all moc files are included from automoc_<target>.cpp).
		+	* If a file, included by a moc source file, changes such that the moc output will change one needs to either touch the moc source file or run make clean to force automoc4 to regenerate the moc file.

← Older revision		Revision as of 15:29, 17 August 2008
Line 56:		Line 56:

	==When are which files generated==		==When are which files generated==
		+
		+	automoc4 regenerates all moc files if
		+	# the -D arguments have changed
		+	# <current binary dir>/automoc_<target>.cpp does not exist
		+
		+	The latter is used by make clean to let all moc files be regenerated.
		+
		+	A single moc file is regenerated if the timestamp of its source file is newer than the timestamp of the generated moc file. It does '''not''' check for the timestamps of files included by the source.

	==Limitations==		==Limitations==