github_mirrors/vectorscan
3
0
Fork 1
mirror of https://github.com/VectorCamp/vectorscan.git synced 2025-06-28 16:41:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

nfa_kind: documentation

Browse Source
This commit is contained in:
Justin Viiret 2016-04-20 09:47:12 +10:00 committed by Matthew Barr
parent ee7f31ac39
commit 061068a260
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/nfa/nfa_kind.h
View File

@ -26,6 +26,12 @@
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
*/ */
/**
* \file
* \brief Data structures and helper functions used to describe the purpose of
* a particular NFA engine at build time.
*/
#ifndef NFA_KIND_H #ifndef NFA_KIND_H
#define NFA_KIND_H #define NFA_KIND_H
@ -43,6 +49,7 @@ enum nfa_kind {
NFA_REV_PREFIX, //! reverse running prefixes (for som) NFA_REV_PREFIX, //! reverse running prefixes (for som)
}; };
/** \brief True if this kind of engine is triggered by a top event. */
inline inline
bool is_triggered(enum nfa_kind k) { bool is_triggered(enum nfa_kind k) {
switch (k) { switch (k) {
@ -55,6 +62,10 @@ bool is_triggered(enum nfa_kind k) {
} }
} }
/**
* \brief True if this kind of engine generates callback events when it
* enters accept states.
*/
inline inline
bool generates_callbacks(enum nfa_kind k) { bool generates_callbacks(enum nfa_kind k) {
switch (k) { switch (k) {
@ -68,6 +79,10 @@ bool generates_callbacks(enum nfa_kind k) {
} }
} }
/**
* \brief True if this kind of engine has reports that are managed by the \ref
* ReportManager.
*/
inline inline
bool has_managed_reports(enum nfa_kind k) { bool has_managed_reports(enum nfa_kind k) {
switch (k) { switch (k) {