Differential D11934 Diff 50830 kdevplatform/language/backgroundparser/parseprojectjob.h

Changeset View

Standalone View

kdevplatform/language/backgroundparser/parseprojectjob.h

Show All 22 Lines
23	#include <language/languageexport.h>	23		#include <language/languageexport.h>
24		24
25	#include <KJob>	25		#include <KJob>
26		26
27	namespace KDevelop {	27		namespace KDevelop {
28	class ReferencedTopDUContext;	28		class ReferencedTopDUContext;
29	class IProject;	29		class IProject;
30		30
31	///A job that parses all project-files in the given project	31		///A job that parses all project-files in the given project either
32	///Deletes itself as soon as the project is deleted	32		///when KDevelop is configured to parse all files at project import
		33		///(see ProjectController:parseAllProjectSources()) or when the
		34		///forceAll argument is true. That forceAll argument allows to
		35		///trigger a full project reparse after the initial import, e.g.
		36		///via the project manager's context menu.
		37		///ParseProjectJob instances delete themselves as soon as the project
		38		///is deleted or when a new job is started.
33	class KDEVPLATFORMLANGUAGE_EXPORT ParseProjectJob : public KJob	39		class KDEVPLATFORMLANGUAGE_EXPORT ParseProjectJob : public KJob
34	{	40		{
35	Q_OBJECT	41		Q_OBJECT
36	public:	42		public:
37	explicit ParseProjectJob(KDevelop::IProject* project, bool forceUpdate = false );	43		explicit ParseProjectJob(KDevelop::IProject* project, bool forceUpdate = false, bool forceAll = false );
			mwolffUnsubmitted Done please document the difference between forcing an update and forcing all - I've figured it out but it wasn't directly obvious to me mwolff: please document the difference between forcing an update and forcing all - I've figured it out…
			rjvbbAuthorUnsubmitted Not Done I can imagine, I had to figure it out for myself again too :-/ rjvbb: I can imagine, I had to figure it out for myself again too :-/
			rjvbbAuthorUnsubmitted Not Done In fact, what do you think of making this explicit ParseProjectJob(KDevelop::IProject* project, bool forceUpdate = false, bool forceAll = ICore::self()->projectController()->parseAllProjectSources() ); You'd need to include 2 icore headers in this file but it'd make the behaviour of the option easier to explain. But we'd probably also need to do the same thing for the corresponding new argument to ProjectController::reparseProject() (but not iProjectController::reparseProjet(), I think)? rjvbb: In fact, what do you think of making this ``` explicit ParseProjectJob(KDevelop::IProject*…
			mwolffUnsubmitted Not Done please don't do that. rather, reuse `ProjectController::reparseProject` below instead of creating the job manually mwolff: please don't do that. rather, reuse `ProjectController::reparseProject` below instead of…
			rjvbbAuthorUnsubmitted Not Done The idea was to move the "should we parse everything and why" logic outside of the function; it's not entirely relevant where the condition is moved to. Could be to this function's declaration, but could probably also be to the reparseProject definition. The point is that parameter could then simply be called "parseAll" and would be easier to explain. You'd also get more control over what the function does; in particular trigger a partial reparse no matter what `parseAllProjectSources()` returns. rjvbb: The idea was to move the "should we parse everything and why" logic outside of the function…
38	~ParseProjectJob() override;	44		~ParseProjectJob() override;
39	void start() override;	45		void start() override;
40	bool doKill() override;	46		bool doKill() override;
41		47
42	private Q_SLOTS:	48		private Q_SLOTS:
43	void deleteNow();	49		void deleteNow();
44	void updateReady(const KDevelop::IndexedString& url, const KDevelop::ReferencedTopDUContext& topContext);	50		void updateReady(const KDevelop::IndexedString& url, const KDevelop::ReferencedTopDUContext& topContext);
45		51
46	private:	52		private:
47	void updateProgress();	53		void updateProgress();
48		54
49	private:	55		private:
50	const QScopedPointer<class ParseProjectJobPrivate> d;	56		const QScopedPointer<class ParseProjectJobPrivate> d;
51	};	57		};
			mwolffUnsubmitted Done move that to the dptr mwolff: move that to the dptr
52		58
53	}	59		}
54		60
55	#endif // KDEVPLATFORM_PARSEPROJECTJOB_H	61		#endif // KDEVPLATFORM_PARSEPROJECTJOB_H