File: detector.h

package info (click to toggle)
ohcount 4.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 8,580 kB
  • sloc: ansic: 7,584; javascript: 3,300; ruby: 2,363; perl: 2,065; objc: 1,325; python: 445; pascal: 398; erlang: 350; sh: 275; lisp: 272; vhdl: 150; haskell: 149; asm: 127; cs: 124; awk: 98; java: 92; php: 77; tcl: 58; xml: 57; fortran: 54; modula3: 32; makefile: 30; ada: 30; jsp: 28; sql: 18; cobol: 13; ml: 9
file content (37 lines) | stat: -rw-r--r-- 1,282 bytes parent folder | download | duplicates (4)
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
// detector.h written by Mitchell Foral. mitchell<att>caladbolg.net.
// See COPYING for license information.

#ifndef OHCOUNT_DETECTOR_H
#define OHCOUNT_DETECTOR_H

/**
 * @page detector_doc Detector Documentation
 *
 * @section language How to Add a New Language
 *
 * @li Add your language to 'src/languages.h' and 'src/hash/languages.gperf'.
 * @li Update 'src/hash/extensions.gperf' to identify files that use the new
 *   language (or 'src/hash/filenames.gperf').
 * @li Regenerate the hash header files with 'src/hash/generate_headers'.
 * @li Add your tests to 'test/unit/detector_test.h', rebuild the tests, and
 *   run them to confirm the detector changes.
 * @li Follow the detailed instructions in the Parser Documentation.
 * @li Rebuild Ohcount.
 */

#include "sourcefile.h"

/**
 * Attempts to detect the programming language used by the given file.
 * The returned pointer is used internally and must not be 'free'd.
 * @param sourcefile A SourceFile created by ohcount_sourcefile_new().
 * @return pointer to a string with the detected language or NULL.
 */
const char *ohcount_detect_language(SourceFile *sourcefile);

int ohcount_is_binary_filename(const char *filename);

/* Exported for unit testing */
void escape_path(char *safe, const char *unsafe);

#endif