Code Completion Design - Revision history

Ollydbg: add a new section

2014-09-08T15:22:31Z

add a new section

Ollydbg: add a new user defined macro replacement rule AAAAA->@

2014-06-24T02:59:04Z

add a new user defined macro replacement rule AAAAA->@

Ollydbg: /* Usefull Links */ add parser links

2014-02-17T15:16:42Z

Usefull Links: add parser links

Ollydbg: /* Usefull Links */ LLVM tutorials

2013-12-01T14:37:21Z

Usefull Links: LLVM tutorials

Ollydbg: /* Usefull Links */ add one link

2013-11-05T14:27:55Z

Usefull Links: add one link

Ollydbg: /* How a new item is added to the tree */ extend a node's edge

2013-10-06T06:23:10Z

How a new item is added to the tree: extend a node's edge

Ollydbg: how new item is added

2013-10-06T06:05:13Z

how new item is added

Ollydbg: /* Structure of CodeCompletion plugin */ add some details.

2013-02-21T03:53:49Z

Structure of CodeCompletion plugin: add some details.

Ollydbg: /* Mutexs and lockers in CC */ macros and lockers

2013-02-21T03:36:44Z

Mutexs and lockers in CC: macros and lockers

Ollydbg: new section:

2013-02-21T03:22:58Z

new section:

@@ Line 237: / Line 237: @@
 Which means, if the tokenizer meet a string "AAAAA", then it will returned a string "BBBBB"
 ==== AAAAA -> +BBBBB====
 For example, when

@@ Line 332: / Line 332: @@
 cvMat * cvFyyy();
 </source>
 ==High level parser(Syntax Analysis)==

← Older revision		Revision as of 15:16, 17 February 2014
Line 876:		Line 876:

	* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]		* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]
		+
		+	* Roberto Raggi's new parser[https://github.com/robertoraggi/cplusplus cplusplus 5 My experimental C++ front end], note Roberto Raggi is the author of the parser for both Qtcreator and Kdeveloper IDE.
		+
		+	* KDevelop are discussing clang now, see [http://milianw.de/blog/katekdevelop-sprint-2014-let-there-be-clang Kate/KDevelop Sprint 2014: Let There Be Clang \| Milian Wolff]

← Older revision		Revision as of 14:37, 1 December 2013
Line 874:		Line 874:

	* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]		* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]
		+
		+	* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]

← Older revision		Revision as of 14:27, 5 November 2013
Line 872:		Line 872:

	*[http://wiki.eclipse.org/CDT/designs/Overview_of_Parsing CDT/designs/Overview of Parsing].		*[http://wiki.eclipse.org/CDT/designs/Overview_of_Parsing CDT/designs/Overview of Parsing].
		+
		+	* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]

@@ Line 546: / Line 546: @@
 </source>
 Here, the middle node "physi" is added. the original node 1's lable is shorten to "cs", and a new node "ology" is added as a new child node to the middle node.
 ===How to query a Token by a keyword===

← Older revision		Revision as of 06:05, 6 October 2013
Line 525:		Line 525:

	For more information, see the forum discussion here. [/index.php/topic,1696.0.html rickg22's SearchTree development] as a reference.		For more information, see the forum discussion here. [/index.php/topic,1696.0.html rickg22's SearchTree development] as a reference.
		+
		+	===How a new item is added to the tree===
		+	When you add a new key (string) to the tree, some node should be splited, and new node need to be added. For example [/index.php/topic,1696.msg12617.html#msg12617 this post]show some details.
		+
		+	Suppose we have two nodes in the tree, the node id is 0 (root node) and 1, the tree hold only one key string(item) "physics":
		+	<source lang = "cpp">
		+	Adding word: physics
		+	1 items in the tree
		+	- "" (0)
		+	\- "physics" (1)
		+	</source>
		+	Now, if another key string "physiology" is added to the tree, we now firstly check "physiology" is already in the tree, if not, we need to find the common string "physi", so the node 1 should be splited after the common string, so you get the following result.
		+	<source lang = "cpp">
		+	Adding word: physiology
		+	2 items in the tree
		+	- "" (0)
		+	\- "physi" (2)
		+	+- "cs" (1)
		+	\- "ology" (3)
		+	</source>
		+	Here, the middle node "physi" is added. the original node 1's lable is shorten to "cs", and a new node "ology" is added as a new child node to the middle node.

	===How to query a Token by a keyword===		===How to query a Token by a keyword===

@@ Line 51: / Line 51: @@
 ==Structure of CodeCompletion plugin==
 [[Image:CodeCompletionPluginStructure.png| Code completion plugin Structure]]
 ==Low level parser(Lexical analysis, Tokenize)==

← Older revision		Revision as of 03:36, 21 February 2013
Line 642:		Line 642:

	==Mutexs and lockers in CC==		==Mutexs and lockers in CC==
		+	We need lockers to avoid multiply thread issues of wxString. More detailed can be found: [/index.php/topic,17543.0.html wxString and the locker issue in our CC code], to avoid such issue, we need lockers.
		+	There are three main kind of lockers.
		+	<nowiki>wxMutex s_ParserMutex;
		+	wxMutex s_TokenTreeMutex;
		+	wxMutex m_ClassBrowserBuilderThreadMutex;</nowiki>
		+	The first one was to protect multiply access to Parser objects, this is a static variable. The second one tries to forbid the multiply access to the TokenTree, the last one is used to build the symbol browser tree(usually show in the left docked panels of the C::B main frame)
		+
		+	The associated Macros are below:
		+	<source lang = "c">
		+	// For tracking, either uncomment:
		+	//#define CC_ENABLE_LOCKER_TRACK
		+	// ...or:
		+	#define CC_ENABLE_LOCKER_ASSERT
		+	// ..or none of the above.
		+
		+	#if defined(CC_ENABLE_LOCKER_TRACK)
		+	// TRACKING MUTXES
		+	// [1] Implementations for tracking mutexes:
		+	#define THREAD_LOCKER_MTX_LOCK(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Lock() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_MTX_LOCK_SUCCESS(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Lock().Success() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_MTX_UNLOCK(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Unlock() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_MTX_UNLOCK_SUCCESS(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Unlock().Success() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_MTX_FAIL(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Fail() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	// [2] Cumulative convenient macros for tracking mutexes [USE THESE!]:
		+	#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) \
		+	{ \
		+	THREAD_LOCKER_MTX_LOCK(M); \
		+	if (M.Lock()==wxMUTEX_NO_ERROR) \
		+	THREAD_LOCKER_MTX_LOCK_SUCCESS(M); \
		+	else \
		+	THREAD_LOCKER_MTX_FAIL(M); \
		+	}
		+	#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) \
		+	{ \
		+	THREAD_LOCKER_MTX_UNLOCK(M); \
		+	if (M.Unlock()==wxMUTEX_NO_ERROR) \
		+	THREAD_LOCKER_MTX_UNLOCK_SUCCESS(M); \
		+	else \
		+	THREAD_LOCKER_MTX_FAIL(M); \
		+	}
		+	#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+	#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+
		+	// TRACKING CRITICAL SECIONS
		+	// [2] Implementations for tracking critical sections:
		+	#define THREAD_LOCKER_CS_ENTER(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Enter() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_CS_ENTERED(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Entered() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	#define THREAD_LOCKER_CS_LEAVE(NAME) \
		+	CCLogger::Get()->DebugLog(F(_T("%s.Leave() : %s(), %s, %d"), \
		+	wxString(#NAME, wxConvUTF8).wx_str(), \
		+	wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
		+	wxString(__FILE__, wxConvUTF8).wx_str(), \
		+	__LINE__))
		+	// [2] Cumulative convenient macros for tracking critical sections [USE THESE!]:
		+	#define CC_LOCKER_TRACK_CS_ENTER(CS) \
		+	{ \
		+	THREAD_LOCKER_CS_ENTER(CS); \
		+	CS.Enter(); \
		+	THREAD_LOCKER_CS_ENTERED(CS); \
		+	}
		+	#define CC_LOCKER_TRACK_CS_LEAVE(CS) \
		+	{ \
		+	THREAD_LOCKER_CS_LEAVE(CS); \
		+	CS.Leave(); \
		+	}
		+	#elif defined CC_ENABLE_LOCKER_ASSERT
		+	#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
		+	#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();
		+
		+	#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) cbAssert(M.Lock()==wxMUTEX_NO_ERROR);
		+	#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) cbAssert(M.Unlock()==wxMUTEX_NO_ERROR);
		+	#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+	#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+	#else
		+	#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
		+	#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();
		+
		+	#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) M.Lock();
		+	#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) M.Unlock();
		+	#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+	#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
		+	#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
		+	#endif
		+	</source>
		+
		+	Each mutex need a Lock and Unlock macro, like for mutex for Parser, we need CC_LOCKER_TRACK_P_MTX_LOCK and CC_LOCKER_TRACK_P_MTX_UNLOCK.

	==Usefull Links==		==Usefull Links==

← Older revision		Revision as of 03:22, 21 February 2013
Line 640:		Line 640:

	[[File:Cc debug smartsense.png]]		[[File:Cc debug smartsense.png]]
		+
		+	==Mutexs and lockers in CC==

	==Usefull Links==		==Usefull Links==