SameBoy | Accurate GB/GBC emulator |
| download: https://git.y1.nz/archives/sameboy.tar.gz | |
| README | Files | Log | Refs | LICENSE |
HexFiend/HexFiend.h
1 /*! @mainpage HexFiend.framework
2 *
3 * @section intro Introduction
4 * HexFiend.framework (hereafter "Hex Fiend" when there is no risk of confusion with the app by the same name) is a framework designed to enable applications to support viewing and editing of binary data. The emphasis is on editing data in a natural way, following Mac OS X text editing conventions.
5 *
6 * Hex Fiend is designed to work efficiently with large amounts (64 bits worth) of data. As such, it can work with arbitrarily large files without reading the entire file into memory. This includes insertions, deletions, and in-place editing. Hex Fiend can also efficiently save such changes back to the file, without requiring any additional temporary disk space.
7 *
8 * Hex Fiend has a clean separation between the model, view, and controller layers. The model layer allows for efficient manipulation of raw data of mixed sources, making it useful for tools that need to work with large files.
9 *
10 * Both the framework and the app are open source under a BSD-style license. In summary, you may use Hex Fiend in any project as long as you include the copyright notice somewhere in the documentation.
11 *
12 * @section requirements Requirements
13 * Hex Fiend is only available on Mac OS X, and supported on Mountain Lion and later.
14 *
15 * @section getting_started Getting Started
16 *
17 * The Hex Fiend source code is available at http://ridiculousfish.com/hexfiend/ and on GitHub at https://github.com/ridiculousfish/HexFiend
18 *
19 * Hex Fiend comes with some sample code ("HexFiendling"), distributed as part of the project. And of course the Hex Fiend application itself is open source, acting as a more sophisticated sample code.
20 */
21
22
23 #import <HexFiend/HFTypes.h>
24 #import <HexFiend/HFFunctions.h>
25 #import <HexFiend/HFController.h>
26 #import <HexFiend/HFRepresenter.h>
27 #import <HexFiend/HFFullMemoryByteArray.h>
28 #import <HexFiend/HFFullMemoryByteSlice.h>
29 #import <HexFiend/HFHexTextRepresenter.h>
30 #import <HexFiend/HFLineCountingRepresenter.h>
31 #import <HexFiend/HFLayoutRepresenter.h>
32 #import <HexFiend/HFStringEncodingTextRepresenter.h>
33 #import <HexFiend/HFVerticalScrollerRepresenter.h>
34 #import <HexFiend/HFByteArray.h>
35 #import <HexFiend/HFBTreeByteArray.h>
36
37
38 /* The following is all for Doxygen */
39
40
41 /*! @defgroup model Model
42 * Hex Fiend's model classes
43 */
44 ///@{
45 ///@class HFByteArray
46 ///@class HFBTreeByteArray
47 ///@class HFFullMemoryByteArray
48 ///@class HFByteSlice
49 ///@class HFFileByteSlice
50 ///@class HFSharedMemoryByteSlice
51 ///@class HFFullMemoryByteSlice
52
53 ///@}
54
55
56 /*! @defgroup view View
57 * Hex Fiend's view classes
58 */
59 ///@{
60 ///@class HFRepresenter
61 ///@class HFHexTextRepresenter
62 ///@class HFStringEncodingTextRepresenter
63 ///@class HFLayoutRepresenter
64 ///@class HFLineCountingRepresenter
65 ///@class HFStatusBarRepresenter
66 ///@class HFVerticalScrollerRepresenter
67 ///@class HFLineCountingRepresenter
68
69 ///@}
70
71 /*! @defgroup controller Controller
72 * Hex Fiend's controller classes
73 */
74 ///@{
75 ///@class HFController
76
77 ///@}
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.