Package IDAscope :: Package idascope :: Package core :: Module WinApiProvider :: Class WinApiProvider
[hide private]
[frames] | no frames]

Class WinApiProvider

source code

Data provider for request concerning WinApi information.

Instance Methods [hide private]
 
__init__(self, idascope_config) source code
 
_load_keywords(self)
Loads the keywords database from the file specified in the config.
source code
 
has_offline_msdn_available(self)
Determines wther the offline MSDN database is available or not.
source code
 
get_keywords_for_initial(self, keyword_initial)
Get all keywords that start with the given initial character.
source code
 
get_keyword_content(self, keyword)
Get the content for this keyword.
source code
 
get_linked_document_content(self, url)
Get the content for a requested linked document
source code
 
get_history_states(self)
Get information about whether history stepping (backward, forward) is available or not.
source code
 
get_previous_document_content(self)
Get the content of the previously accessed document.
source code
 
get_next_document_content(self)
Get the content of the previously accessed document.
source code
 
_cleanup_histories(self)
Eliminate subsequent similar items from history lists
source code
 
_cleanup_list(self, input_list)
Eliminate subsequent similar items from a list
source code
 
_get_api_filenames(self, keyword)
Get filenames that are associated with the given keyword.
source code
 
_get_document_content(self, filenames)
Produce the document content for a given list of filenames.
source code
 
_generate_html_list_of_filenames(self, filenames)
Convert a list of filenames as string into a mini-HTML document with the list entries as links to the files in a bullet list.
source code
 
_get_single_document_content(self, filename)
Load a single document by filename and return its content.
source code
Method Details [hide private]

has_offline_msdn_available(self)

source code 

Determines wther the offline MSDN database is available or not. This is evaluated based on whether the keywords database has been loaded or not.

Returns:
(bool) availablity of the MSDN database

get_keywords_for_initial(self, keyword_initial)

source code 

Get all keywords that start with the given initial character.

Parameters:
  • keyword_initial (str) - an initial character
Returns:
(a list of str) keywords in WinApi that start with that initial.

get_keyword_content(self, keyword)

source code 

Get the content for this keyword.

Parameters:
  • keyword (str)
Returns:
(str) HTML content.

get_linked_document_content(self, url)

source code 

Get the content for a requested linked document

Parameters:
  • url (QUrl) - URL of the requested file
Returns:
a tuple (str, str) with content and anchor within the content

get_history_states(self)

source code 

Get information about whether history stepping (backward, forward) is available or not.

Returns:
a tuple (boolean, boolean) telling about availability of history stepping.

get_previous_document_content(self)

source code 

Get the content of the previously accessed document. This implements the well-known "back"-button functionality.

Returns:
a tuple (str, str) with content and anchor within the content

get_next_document_content(self)

source code 

Get the content of the previously accessed document. This implements the well-known "back"-button functionality.

Returns:
a tuple (str, str) with content and anchor within the content

_cleanup_list(self, input_list)

source code 

Eliminate subsequent similar items from a list

Parameters:
  • input_list (list) - A list of arbitrary items
Returns:
(list) the input list without subsequent similar items

_get_api_filenames(self, keyword)

source code 

Get filenames that are associated with the given keyword.

Parameters:
  • keyword (str) - keyword to get the filenames for
Returns:
(a list of str) filenames that cover this keyword.

_get_document_content(self, filenames)

source code 

Produce the document content for a given list of filenames. If there are multiple filenames, no document content is returned but a rendered list fo the filenames,

Parameters:
  • filenames (list of str) - the filename(s) to get content for
Returns:
(str) HTML content.

_generate_html_list_of_filenames(self, filenames)

source code 

Convert a list of filenames as string into a mini-HTML document with the list entries as links to the files in a bullet list.

Parameters:
  • filenames (list of str) - the filenames to include in the bullet list
Returns:
(str) a HTML file with a bullet list of links to the filenames

_get_single_document_content(self, filename)

source code 

Load a single document by filename and return its content.

Parameters:
  • filename (str) - the filename to load
Returns:
(str) the content of the file