1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/* File: gui_search_runner.h; Copyright and License: see below */
#ifndef GUI_SEARCH_RUNNER_H
#define GUI_SEARCH_RUNNER_H
/* public file for the doxygen documentation: */
/*! \file
* \brief Gets a search query string, performs the search and provides the search result.
*/
#include "sketch/gui_sketch_area.h"
#include "storage/data_database_reader.h"
#include "storage/data_database_text_search.h"
#include "set/data_small_set.h"
#include "set/data_search_result.h"
#include "set/data_search_result_list.h"
#include "entity/data_diagramelement.h"
#include "entity/data_feature.h"
#include "entity/data_relationship.h"
#include "gui_simple_message_to_user.h"
/*!
* \brief constants for maximum values of gui_search_runner_t
*/
enum gui_search_runner_max_enum {
GUI_SEARCH_RUNNER_MAX_RESULTS = GUI_SKETCH_RESULT_LIST_MAX_ARRAY_SIZE, /*!< maximum number of search results */
};
/*!
* \brief attributes of the gui_search_runner
*/
struct gui_search_runner_struct {
data_database_reader_t *db_reader; /*!< pointer to external database reader */
data_database_text_search_t db_searcher; /*!< own instance of a database freetext searcher */
gui_sketch_area_t *result_consumer; /*!< pointer to external gui_sketch_area_t which is informed on search results */
gui_simple_message_to_user_t *message_to_user; /*!< pointer to external message-displayer */
data_search_result_t temp_result_list_buf[GUI_SEARCH_RUNNER_MAX_RESULTS]; /*!< memory for the result list */
data_search_result_list_t temp_result_list;
data_diagram_t temp_diagram; /*!< memory to read a diagram */
data_diagramelement_t temp_diagramelement; /*!< memory to read a diagram element */
data_feature_t temp_feature; /*!< memory to read a feature */
data_relationship_t temp_relationship; /*!< memory to read a relationship */
data_classifier_t temp_classifier; /*!< memory to read a classifier */
};
typedef struct gui_search_runner_struct gui_search_runner_t;
/*!
* \brief initializes the gui_search_runner_t struct
*
* \param this_ pointer to own object attributes
* \param message_to_user pointer to external message-displayer
* \param db_reader pointer to external database reader
* \param database pointer to external database - used to create a data_database_text_search_t
* \param result_consumer pointer to external gui_sketch_area_t which is informed on search results
*/
void gui_search_runner_init ( gui_search_runner_t *this_,
gui_simple_message_to_user_t *message_to_user,
data_database_reader_t *db_reader,
data_database_t *database,
gui_sketch_area_t *result_consumer
);
/*!
* \brief destroys the gui_search_runner_t struct
*
* \param this_ pointer to own object attributes
*/
void gui_search_runner_destroy ( gui_search_runner_t *this_ );
/*!
* \brief performs a search and informs the result_consumer of result set
*
* \param this_ pointer to own object attributes
* \param search_string search query, 0-terminated
*/
void gui_search_runner_run ( gui_search_runner_t *this_, const char* search_string );
/*!
* \brief searches diagrams in which a given classifier is visible and adds their ids to a result set
*
* \param this_ pointer to own object attributes
* \param classifier_template a search result template that is already half-filled, only the diagram information is missing
* \param io_list list to which to add an entry for each found diagram
*/
void gui_search_runner_private_add_diagrams_of_classifier ( gui_search_runner_t *this_,
data_search_result_t *classifier_template,
data_search_result_list_t *io_list
);
#endif /* GUI_SEARCH_RUNNER_H */
/*
Copyright 2020-2025 Andreas Warnke
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
|
