Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dc51d5fe16 | ||
|
|
b091a0902e | ||
|
|
e30f47f5de | ||
|
|
469f520b30 | ||
|
|
5ed77ef1bb | ||
|
|
37288d81a7 | ||
|
|
e6d52eed44 | ||
|
|
9b23f42a0a | ||
|
|
78bae22fb2 | ||
|
|
667aaff62d | ||
|
|
8a51ef8524 | ||
|
|
56bd22f4e3 | ||
|
|
2abcacb722 | ||
|
|
a727f93d0e | ||
|
|
272f0da513 | ||
|
|
64fecfbebb | ||
|
|
869998b58a | ||
|
|
f0cef8e4f5 | ||
|
|
2b47060190 | ||
|
|
eaba7bbdad | ||
|
|
beae7d7551 | ||
|
|
d7970177f3 | ||
|
|
cd7a2d08ca | ||
|
|
c3409ab251 | ||
|
|
18ac71a371 | ||
|
|
8ccd7d9dd5 | ||
|
|
c15b35c74f | ||
|
|
272a9da194 | ||
|
|
2cd5d0109c | ||
|
|
8b48ce96e1 | ||
|
|
108c605897 | ||
|
|
70be993cfd | ||
|
|
09d7d62632 | ||
|
|
534dfde000 | ||
|
|
75e4afe5ce | ||
|
|
c0eeba3cfc | ||
|
|
0976bf2aa8 | ||
|
|
b658b2bbc2 | ||
|
|
d934619abe | ||
|
|
d68207b59e | ||
|
|
672acd902b | ||
|
|
9735074c7c | ||
|
|
3b89622ba8 | ||
|
|
77be9b82c1 | ||
|
|
620ac0081f | ||
|
|
1a0a486c71 | ||
|
|
3feb7b2a93 | ||
|
|
d4ca777cbd | ||
|
|
9101519e26 | ||
|
|
1896d7ffec | ||
|
|
5871f6ea1c | ||
|
|
d7fe9272b8 | ||
|
|
40ee584fcf | ||
|
|
93a24b3ad0 | ||
|
|
661d273ab7 | ||
|
|
3aee0c3548 | ||
|
|
dd60c551cd | ||
|
|
1c984ae94b | ||
|
|
ddac25ee39 | ||
|
|
2fe18dead5 | ||
|
|
b16408049b | ||
|
|
110fa13b1d | ||
|
|
d911376774 | ||
|
|
3a246798b8 | ||
|
|
0de3f90b6c | ||
|
|
4c7e23e0a6 | ||
|
|
9b6bce7e58 | ||
|
|
9e3f9f6345 | ||
|
|
a1356fbdd9 | ||
|
|
d33a8dc7a2 | ||
|
|
e1b5e909c4 | ||
|
|
cbf7bc6a3d | ||
|
|
1ae192e48e | ||
|
|
0dc095ff71 | ||
|
|
e5277f39a1 | ||
|
|
e5444aa9e6 | ||
|
|
bbaa1abfe5 | ||
|
|
a101ba7167 | ||
|
|
33b32edb4a | ||
|
|
ecc7d05a05 | ||
|
|
3efbbc85ab | ||
|
|
7a3e617585 | ||
|
|
6767934906 | ||
|
|
85f757efb9 | ||
|
|
132ef13af6 | ||
|
|
4329e20359 | ||
|
|
6babbbdfe9 | ||
|
|
f7318c3033 | ||
|
|
80ff0a6f7b | ||
|
|
dfb48fcf0c | ||
|
|
3cd046fdd0 | ||
|
|
df65aa9aa6 | ||
|
|
5f9a0840cc | ||
|
|
805db97abd | ||
|
|
53afe35b12 | ||
|
|
01535f4add | ||
|
|
ecf6b96e0f | ||
|
|
77b005988b | ||
|
|
db2de36a4d | ||
|
|
c713c88749 | ||
|
|
7a32c6789b | ||
|
|
78522cca81 | ||
|
|
a50927e039 | ||
|
|
e821ddc1c8 | ||
|
|
7116de1a7e | ||
|
|
463dbccce4 | ||
|
|
0b8635565d | ||
|
|
5b9b68bc92 | ||
|
|
cbf1992d78 | ||
|
|
f799eaf0cd | ||
|
|
3c605a4480 | ||
|
|
6c66b28c1f | ||
|
|
876858458a | ||
|
|
d090071923 | ||
|
|
2c3b4588ef | ||
|
|
7fb52ccd4c | ||
|
|
b9c02025f5 | ||
|
|
e354190c31 | ||
|
|
6feb079005 | ||
|
|
cccaa3772a | ||
|
|
9ec1261ab9 | ||
|
|
e529aebeb7 | ||
|
|
a98efe0cfb | ||
|
|
269cbac239 | ||
|
|
f74826f047 | ||
|
|
a33a73009f | ||
|
|
e3cf502fe4 | ||
|
|
0764c4304a | ||
|
|
697543fcf9 | ||
|
|
16fe40f7ae | ||
|
|
c909eeecf6 | ||
|
|
148d77cf20 | ||
|
|
5472217f77 | ||
|
|
6e6d40ed7e | ||
|
|
32203ce9a0 | ||
|
|
69bce2f516 | ||
|
|
46a89eab47 | ||
|
|
f8652d9f62 | ||
|
|
960fdaa9c7 | ||
|
|
2e503d5a17 | ||
|
|
dfb16cf2ee | ||
|
|
7fbd28f918 | ||
|
|
b773f2b0c3 | ||
|
|
32cbe65a6a | ||
|
|
88227b6623 | ||
|
|
3721ec82fb | ||
|
|
5b7ae60d45 | ||
|
|
3890f557f2 | ||
|
|
2d78b57122 | ||
|
|
23d04633cd | ||
|
|
3cef6ddb48 | ||
|
|
2aa1788c47 | ||
|
|
1f2f8d2d9d | ||
|
|
1c1c21ca56 | ||
|
|
8677adc55f | ||
|
|
9790012e0b | ||
|
|
9159b74a24 | ||
|
|
f000631de3 | ||
|
|
881942a2da | ||
|
|
d2382f2277 | ||
|
|
65a1947cca | ||
|
|
765fce3cba | ||
|
|
449c68fb53 | ||
|
|
c8fb13aca7 | ||
|
|
1f9b0c2d69 | ||
|
|
1dd91e9816 | ||
|
|
ca5f2c49b1 | ||
|
|
0f6275c7d6 | ||
|
|
721886dffd | ||
|
|
d2f66434bd | ||
|
|
a20b38040f | ||
|
|
1ea689eeab | ||
|
|
aca7a39874 | ||
|
|
86ffdf1573 | ||
|
|
664010f73c | ||
|
|
6cc6b0ed89 | ||
|
|
4798d300c8 | ||
|
|
21945707ac | ||
|
|
4f368aede9 | ||
|
|
98927ba160 | ||
|
|
61251d240f | ||
|
|
c9caa6dd31 | ||
|
|
1c70bb035a | ||
|
|
da28e011a6 | ||
|
|
683f1547b2 | ||
|
|
d8c4119081 | ||
|
|
d44e7202c5 | ||
|
|
6715ad5a71 | ||
|
|
7e7351b673 | ||
|
|
f5fdf6dd55 | ||
|
|
e694e635f7 | ||
|
|
9c6d155b17 | ||
|
|
ba2b1be0ed | ||
|
|
9178631f2c | ||
|
|
982afc74ab | ||
|
|
1b7ff712bc | ||
|
|
2cc47c2afc | ||
|
|
6fd1855f5a | ||
|
|
c8ff6f790e | ||
|
|
87afe62dbc | ||
|
|
611681e337 | ||
|
|
c30acdbd6c | ||
|
|
23cc2ba418 | ||
|
|
a7c0d97851 | ||
|
|
cfa8d42427 | ||
|
|
992f2a798e | ||
|
|
92017195d5 | ||
|
|
2230fd150e | ||
|
|
041a1bdeef | ||
|
|
b8a42d8811 | ||
|
|
f449b2df1f | ||
|
|
fd1b8a580f | ||
|
|
24a2eba21c | ||
|
|
afaa7df55d | ||
|
|
2e5cb221f5 | ||
|
|
87ffadd845 | ||
|
|
89c9815d73 | ||
|
|
ec03746e73 | ||
|
|
0b60cd3e6e | ||
|
|
28a1099603 | ||
|
|
4fee82575e | ||
|
|
745edde713 | ||
|
|
7d09ac6a21 | ||
|
|
622cc7b820 | ||
|
|
30843136ac | ||
|
|
0528d7fa42 | ||
|
|
821ffa8a28 | ||
|
|
26dc5d077f | ||
|
|
d55b59fecf | ||
|
|
c368635b95 | ||
|
|
57ec892ce3 | ||
|
|
3a98e2e39d | ||
|
|
7fad10bda6 | ||
|
|
61d3f92c6a | ||
|
|
f18f73483e | ||
|
|
c6497d725c | ||
|
|
f98748ec56 | ||
|
|
7516f42fa0 | ||
|
|
004e01e555 | ||
|
|
5baddee782 | ||
|
|
054e60d1fc | ||
|
|
b1bafef891 | ||
|
|
8d83be5bdb | ||
|
|
d8ef031835 | ||
|
|
247299ab97 | ||
|
|
d546474470 | ||
|
|
54dc54d591 | ||
|
|
bea089d93a |
No files matched your search
@@ -1,98 +0,0 @@
|
||||
version: '1.12.0-git-{build}'
|
||||
image: 'Previous Visual Studio 2019'
|
||||
clone_depth: 1
|
||||
|
||||
# Build configuration
|
||||
configuration:
|
||||
- Release
|
||||
|
||||
# Environment
|
||||
environment:
|
||||
NINJA_URL: https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-win.zip
|
||||
VSVARSALLPATH: 'C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat'
|
||||
QTPATH: 'cutter-deps\qt'
|
||||
USE_APPVEYOR_QT: 'false'
|
||||
matrix:
|
||||
# Build: qmake vs2017 x86 shared
|
||||
#- ARCH: x86
|
||||
# PYTHON: 'C:\Python36'
|
||||
# QMAKE: 1
|
||||
# DEPLOY: true
|
||||
# QTPATH: 'C:\Qt\5.12\msvc2017'
|
||||
# USE_APPVEYOR_QT: true
|
||||
# Build: qmake vs2017 x64 shared
|
||||
- ARCH: x64
|
||||
PYTHON: 'C:\Python36-x64'
|
||||
QMAKE: 1
|
||||
DEPLOY: true
|
||||
# Build: meson ninja x64 static
|
||||
- ARCH: x64
|
||||
PYTHON: 'C:\Python36-x64'
|
||||
MESON: 1
|
||||
BACKEND: ninja
|
||||
DEPLOY: false
|
||||
|
||||
install:
|
||||
- ps: $env:path = ($env:path -split ";").Where({!($_ -like "*Microsoft SQL Server*")}) -join ";"
|
||||
- cmd: C:\msys64\usr\bin\bash -lc "cd $APPVEYOR_BUILD_FOLDER && scripts/fetch_deps.sh"
|
||||
- cmd: set "IAITO_DEPS_DIR=%APPVEYOR_BUILD_FOLDER%\cutter-deps"
|
||||
- cmd: set "PATH=%CD%;%PYTHON%;%PATH%"
|
||||
- cmd: call "%VSVARSALLPATH%" %ARCH%
|
||||
- cmd: if "%USE_APPVEYOR_QT%" == "false" ( set "QTPATH=%APPVEYOR_BUILD_FOLDER%\%QTPATH%" )
|
||||
- cmd: set "PATH=%QTPATH%\bin;%PYTHON%\Scripts\;%PATH%"
|
||||
- cmd: echo %PATH%
|
||||
- cmd: python -m pip install meson==0.52
|
||||
- cmd: where meson.exe
|
||||
- cmd: powershell -Command "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; wget %NINJA_URL% -OutFile ninja.zip; Expand-Archive .\ninja.zip -DestinationPath ."
|
||||
# Artifacts
|
||||
- cmd: set "ARTIFACT_NAME=Iaito-v1.12.0-%ARCH%.Windows"
|
||||
- cmd: if defined MESON ( set "ARTIFACT_PATH=dist_%ARCH%" ) else ( set "ARTIFACT_PATH=build_%ARCH%\cutter" )
|
||||
|
||||
before_build:
|
||||
- cmd: git submodule update --init
|
||||
- scripts\prepare_breakpad.bat
|
||||
|
||||
# Build config
|
||||
build_script:
|
||||
- cmd: if defined QMAKE ( call prepare_r2.bat )
|
||||
- cmd: if defined QMAKE ( C:\msys64\usr\bin\bash -lc "export PATH=\"/c/msys64/usr/bin:$PATH\" && cd \"$APPVEYOR_BUILD_FOLDER\" && scripts/appveyor_r2ghidra.sh" )
|
||||
- cmd: if defined QMAKE ( call build.bat IAITO_APPVEYOR_R2DEC=true IAITO_R2GHIDRA_STATIC=true R2GHIDRA_SOURCE="%APPVEYOR_BUILD_FOLDER%/r2ghidra" R2GHIDRA_INSTALL_PATH="%APPVEYOR_BUILD_FOLDER%/r2_dist/lib/plugins" IAITO_ENABLE_CRASH_REPORTS=true IAITO_ENABLE_PYTHON=true IAITO_ENABLE_PYTHON_BINDINGS=true IAITO_DEPS_DIR="%IAITO_DEPS_DIR%" )
|
||||
- cmd: if defined MESON ( python meson.py --release --dist=%ARTIFACT_PATH% --backend=%BACKEND% --python )
|
||||
|
||||
after_build:
|
||||
- cmd: if defined QMAKE ( set "PATH=%CD%\r2_dist\bin;%PATH%" && powershell scripts\bundle_r2dec.ps1 "%CD%\%ARTIFACT_PATH%" )
|
||||
#- cmd: if defined QMAKE ( C:\msys64\usr\bin\bash -lc "export PATH=\"/c/msys64/usr/bin:$PATH\" && cd \"$APPVEYOR_BUILD_FOLDER\" && scripts/appveyor_r2ghidra.sh" )
|
||||
#- cmd: powershell scripts\bundle_openssl.ps1 %ARCH% "%CD%\%ARTIFACT_PATH%"
|
||||
- cmd: powershell scripts\bundle_python.ps1 %ARCH% "%CD%\%ARTIFACT_PATH%"
|
||||
- cmd: xcopy "%IAITO_DEPS_DIR%\pyside\lib\site-packages" "%ARTIFACT_PATH%\python36\site-packages" /e /i /h
|
||||
- cmd: copy "%IAITO_DEPS_DIR%\pyside\bin\shiboken2.abi3.dll" "%ARTIFACT_PATH%\"
|
||||
- cmd: copy "%IAITO_DEPS_DIR%\pyside\bin\pyside2.abi3.dll" "%ARTIFACT_PATH%\"
|
||||
|
||||
# Tests
|
||||
test: off
|
||||
|
||||
# Artifacts
|
||||
artifacts:
|
||||
- path: "%ARTIFACT_PATH%"
|
||||
name: "%ARTIFACT_NAME%"
|
||||
|
||||
deploy:
|
||||
description: 'Iaito binaries'
|
||||
provider: GitHub
|
||||
auth_token:
|
||||
secure: 2SmsqS2RaX2N5c9UwUcfBwNmMX64FfPAZFShLyxIkZXiC8vLaYCHToWxBYEuWRSk
|
||||
artifact: "%ARTIFACT_NAME%"
|
||||
draft: true
|
||||
prerelease: true
|
||||
on:
|
||||
appveyor_repo_tag: true
|
||||
DEPLOY: true
|
||||
|
||||
for:
|
||||
-
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
-
|
||||
skip_non_tags: true
|
||||
|
||||
@@ -4,18 +4,20 @@ about: Create a report to help us improve
|
||||
|
||||
---
|
||||
|
||||
## Environment Details
|
||||
|
||||
Despite we only fix issues reproducible in git-master branch, it's fine to report issues found in releases. And those will be closed when a new release comes out.
|
||||
## Environment
|
||||
|
||||
```sh
|
||||
# copypaste this script into your shell and replace it with the output
|
||||
iaito -v
|
||||
date
|
||||
r2 -v
|
||||
iaito -v
|
||||
uname -ms
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Explain what's the issue, how to repro and what you expect, we love screenshots -->
|
||||
<!-- Explain what's the issue and what would you expect to see -->
|
||||
|
||||
## Test
|
||||
|
||||
<!-- Steps to reproduce the issue and provide files/links/images/.. -->
|
||||
@@ -1,23 +0,0 @@
|
||||
<!-- Filling this template is mandatory -->
|
||||
|
||||
**Your checklist for this pull request**
|
||||
- [ ] I've read the [guidelines for contributing](https://cutter.re/docs/contributing/code/getting-started.html) to this repository
|
||||
- [ ] I made sure to follow the project's [coding style](https://cutter.re/docs/contributing/code/development-guidelines.html)
|
||||
- [ ] I've updated the [documentation](https://cutter.re/docs/user-docs.html) with the relevant information (if needed)
|
||||
|
||||
|
||||
**Detailed description**
|
||||
|
||||
<!-- Explain the **details** for making this change. Is a new feature implemented? What existing problem does the pull request solve? How does the pull request solve these issues? Please provide enough information so that others can review your pull request. -->
|
||||
|
||||
**Test plan (required)**
|
||||
|
||||
<!-- What steps should the reviewer take to test your pull request? Demonstrate that the code is solid. Example: The exact actions you made and their outcome. Add screenshots/videos if the pull request changes UI. This is your time to re-check that everything works and that you covered all the edge cases -->
|
||||
|
||||
|
||||
<!-- **Code formatting**
|
||||
Make sure you ran astyle on your code before making the PR. Check our contribution guidelines here: https://cutter.re/docs/code.html -->
|
||||
|
||||
**Closing issues**
|
||||
|
||||
<!-- put "closes #XXXX" in your comment to auto-close the issue that your PR fixes (if such). -->
|
||||
@@ -1,5 +1,8 @@
|
||||
name: iaito CI
|
||||
|
||||
env:
|
||||
R2V: 5.9.4
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
@@ -12,52 +15,48 @@ jobs:
|
||||
acr-linux-r2git:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # 'recursive' 'true' or 'false'
|
||||
submodules: false # 'recursive' 'true' or 'false'
|
||||
persist-credentials: false
|
||||
- uses: actions/setup-python@v1
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.7.x
|
||||
python-version: 3.11.x
|
||||
- name: apt dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libgraphviz-dev mesa-common-dev ninja-build
|
||||
sudo apt-get install qt5-default libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
sudo apt install -y libgraphviz-dev mesa-common-dev ninja-build meson
|
||||
sudo apt install -y libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
sudo apt install -y qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools
|
||||
- name: install r2
|
||||
run: |
|
||||
git clone --depth=1 https://github.com/radareorg/radare2 r2git
|
||||
cd r2git && sys/install.sh
|
||||
run: git clone --depth=1 https://github.com/radareorg/radare2 r2git && CFLAGS=-O0 r2git/sys/install.sh
|
||||
- name: build iaito
|
||||
run: |
|
||||
./configure --prefix=/usr
|
||||
make -j4
|
||||
- name: packaging
|
||||
run: |
|
||||
make -C dist/debian
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: iaito-amd64.deb
|
||||
path: dist/debian/*/*.deb
|
||||
make -j -C dist/debian
|
||||
acr-linux:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # 'recursive' 'true' or 'false'
|
||||
submodules: false # 'recursive' 'true' or 'false'
|
||||
persist-credentials: false
|
||||
- uses: actions/setup-python@v1
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.7.x
|
||||
python-version: 3.11.x
|
||||
- name: apt dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libgraphviz-dev mesa-common-dev ninja-build
|
||||
sudo apt-get install qt5-default libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
sudo apt install -y libgraphviz-dev mesa-common-dev ninja-build
|
||||
sudo apt install -y libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
sudo apt install -y qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools
|
||||
- name: install r2
|
||||
run: |
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/5.2.1/radare2_5.2.1_amd64.deb
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/5.2.1/radare2-dev_5.2.1_amd64.deb
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/${{env.R2V}}/radare2_${{env.R2V}}_amd64.deb
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/${{env.R2V}}/radare2-dev_${{env.R2V}}_amd64.deb
|
||||
sudo dpkg -i *.deb
|
||||
- name: build iaito
|
||||
run: |
|
||||
@@ -66,206 +65,295 @@ jobs:
|
||||
- name: packaging
|
||||
run: |
|
||||
make -C dist/debian
|
||||
- uses: actions/upload-artifact@v2
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: iaito-amd64.deb
|
||||
path: dist/debian/*/*.deb
|
||||
acr-macos:
|
||||
runs-on: macos-latest
|
||||
acr-macos-x64:
|
||||
runs-on: macos-12
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # 'recursive' 'true' or 'false'
|
||||
submodules: false # 'recursive' 'true' or 'false'
|
||||
persist-credentials: false
|
||||
- uses: actions/setup-python@v1
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.7.x
|
||||
python-version: 3.11.x
|
||||
- name: uname
|
||||
run: uname -a
|
||||
- name: homebrew dependencies
|
||||
run: |
|
||||
brew update
|
||||
brew install coreutils pkg-config qt5
|
||||
brew link qt5 --force
|
||||
brew update || true
|
||||
brew install pkg-config qt@5 || true
|
||||
brew unlink qt@5 || true
|
||||
brew link --force qt@5 || true
|
||||
pip3 install meson
|
||||
pip3 install ninja
|
||||
- name: install r2
|
||||
run: |
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/5.2.1/radare2-5.2.1.pkg
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/${{env.R2V}}/radare2-x64-${{env.R2V}}.pkg
|
||||
sudo installer -pkg *.pkg -target /
|
||||
- name: build iaito
|
||||
run: |
|
||||
# export PATH="/usr/local/opt/qt/bin:$PATH" # doesnt seems to be necessary
|
||||
export PATH="/usr/local/opt/qt@5/bin:$PATH"
|
||||
export PATH="/opt/homebrew/opt/qt@5/bin:$PATH" # doesnt seems to be necessary
|
||||
export LDFLAGS="-L/usr/local/opt/qt@5/lib"
|
||||
export CPPFLAGS="-I/usr/local/opt/qt@5/include"
|
||||
export PKG_CONFIG_PATH="/usr/local/opt/qt@5/lib/pkgconfig"
|
||||
./configure
|
||||
make -j4
|
||||
- name: packaging
|
||||
run: |
|
||||
make -C dist/macos
|
||||
- uses: actions/upload-artifact@v2
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: iaito-mac.pkg
|
||||
path: dist/macos/macos-pkg/iaito*.pkg
|
||||
build:
|
||||
name: iaito-x64.dmg
|
||||
path: dist/macos/iaito.dmg
|
||||
acr-macos-m1:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: false # 'recursive' 'true' or 'false'
|
||||
persist-credentials: false
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.11.x
|
||||
- name: uname
|
||||
run: uname -a
|
||||
- name: homebrew dependencies
|
||||
run: |
|
||||
brew update || true
|
||||
brew install pkg-config qt@5 || true
|
||||
brew unlink qt@5 || true
|
||||
brew link --force qt@5 || true
|
||||
pip3 install meson
|
||||
pip3 install ninja
|
||||
- name: install r2
|
||||
run: |
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/${{env.R2V}}/radare2-m1-${{env.R2V}}.pkg
|
||||
sudo installer -pkg *.pkg -target /
|
||||
- name: build iaito
|
||||
run: |
|
||||
export PATH="/usr/local/opt/qt@5/bin:$PATH"
|
||||
export PATH="/opt/homebrew/opt/qt@5/bin:$PATH" # doesnt seems to be necessary
|
||||
export LDFLAGS="-L/usr/local/opt/qt@5/lib"
|
||||
export CPPFLAGS="-I/usr/local/opt/qt@5/include"
|
||||
export PKG_CONFIG_PATH="/usr/local/opt/qt@5/lib/pkgconfig"
|
||||
./configure
|
||||
make -j4
|
||||
- name: packaging
|
||||
run: |
|
||||
make -C dist/macos
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: iaito-m1.dmg
|
||||
path: dist/macos/iaito.dmg
|
||||
meson:
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-20.04, ubuntu-18.04, macos-latest, windows-latest]
|
||||
python-version: [3.7.x]
|
||||
system-deps: [false]
|
||||
os: [ubuntu-22.04, ubuntu-20.04]
|
||||
python-version: [3.8.x]
|
||||
system-deps: [true]
|
||||
cc-override: [default]
|
||||
cxx-override: [default]
|
||||
# Prevent one job from pausing the rest
|
||||
fail-fast: false
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # 'recursive' 'true' or 'false'
|
||||
submodules: false # 'recursive' 'true' or 'false'
|
||||
persist-credentials: false
|
||||
- name: apt dependencies
|
||||
if: contains(matrix.os, 'ubuntu')
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libgraphviz-dev mesa-common-dev
|
||||
sudo apt-get install ninja-build
|
||||
if [[ "${{ matrix.system-deps }}" = "true" ]]
|
||||
then
|
||||
sudo apt-get install qt5-default libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
fi
|
||||
- uses: actions/setup-python@v1
|
||||
sudo apt-get install ninja-build make git patch wget
|
||||
sudo apt install -y libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
sudo apt install -y qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools
|
||||
- name: install r2
|
||||
run: git clone --depth=1 https://github.com/radareorg/radare2 r2git && CFLAGS=-O0 r2git/sys/install.sh
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: homebrew dependencies
|
||||
if: contains(matrix.os, 'macos')
|
||||
run: |
|
||||
cd scripts
|
||||
rm '/usr/local/bin/2to3' # symlink to some kind of existing python2.7 installation conflicts with brew python3 which gets installed as indirect dependency
|
||||
brew update --preinstall # temporary workaround for https://github.com/Homebrew/homebrew-bundle/issues/751
|
||||
brew bundle
|
||||
brew install coreutils
|
||||
brew install pkg-config
|
||||
- name: py dependencies
|
||||
brew install coreutils pkg-config || true
|
||||
brew install pkg-config qt@5 || true
|
||||
brew unlink qt@5 || true
|
||||
brew link --force qt@5 || true
|
||||
pip3 install meson
|
||||
pip3 install ninja
|
||||
- name: macos build
|
||||
if: contains(matrix.os, 'macos')
|
||||
run: |
|
||||
cd src && meson ../build
|
||||
cd ../build && ninja -j4
|
||||
- name: meson+ninja ubuntu
|
||||
if: contains(matrix.os, 'ubuntu')
|
||||
run: |
|
||||
pip install meson
|
||||
- uses: actions/upload-artifact@v2
|
||||
if: contains(matrix.os, 'ubuntu')
|
||||
cd src && meson ../build
|
||||
cd ../build && ninja -j4
|
||||
w64-meson:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
name: iaito_amd64.deb
|
||||
path: dist/debian/*/*.deb
|
||||
- name: cmake ubuntu
|
||||
if: contains(matrix.os, 'ubuntu')
|
||||
run: |
|
||||
if [[ "${{ matrix.system-deps }}" = "false" ]]
|
||||
then
|
||||
scripts/fetch_deps.sh
|
||||
source cutter-deps/env.sh
|
||||
export PKG_CONFIG_PATH="$CUTTER_DEPS_PYTHON_PREFIX/lib/pkgconfig:${PKG_CONFIG_PATH:-}"
|
||||
export LD_LIBRARY_PATH="`llvm-config --libdir`:$LD_LIBRARY_PATH"
|
||||
fi
|
||||
set -euo pipefail #TODO: move to top once cutter-deps doesn't fail
|
||||
if [[ "${{ matrix.cc-override }}" != "default" ]]
|
||||
then
|
||||
export CC="${{matrix.cc-override}}"
|
||||
export CXX="${{matrix.cxx-override}}"
|
||||
fi
|
||||
|
||||
source scripts/prepare_breakpad_linux.sh
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:${PKG_CONFIG_PATH:-}" #
|
||||
mkdir build
|
||||
cd build
|
||||
cmake --version
|
||||
if [[ "${{ matrix.system-deps }}" = "false" ]]
|
||||
then
|
||||
cmake \
|
||||
-G Ninja \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DIAITO_ENABLE_PYTHON=ON \
|
||||
-DPYTHON_LIBRARY="$CUTTER_DEPS_PYTHON_PREFIX/lib/libpython3.6m.so.1.0" \
|
||||
-DPYTHON_INCLUDE_DIR="$CUTTER_DEPS_PYTHON_PREFIX/include/python3.6m" \
|
||||
-DPYTHON_EXECUTABLE="$CUTTER_DEPS_PYTHON_PREFIX/bin/python3" \
|
||||
-DIAITO_ENABLE_PYTHON_BINDINGS=OFF \
|
||||
-DIAITO_ENABLE_CRASH_REPORTS=ON \
|
||||
-DIAITO_USE_BUNDLED_RADARE2=ON \
|
||||
../src
|
||||
else
|
||||
cmake \
|
||||
-G Ninja \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DIAITO_USE_BUNDLED_RADARE2=ON \
|
||||
../src
|
||||
fi
|
||||
ninja
|
||||
- name: cmake macos
|
||||
shell: bash
|
||||
if: contains(matrix.os, 'macos')
|
||||
run: |
|
||||
scripts/fetch_deps.sh
|
||||
source cutter-deps/env.sh
|
||||
set -euo pipefail
|
||||
wget -q https://github.com/radareorg/radare2/releases/download/5.2.1/radare2-5.2.1.pkg
|
||||
sudo installer -pkg *.pkg -target /
|
||||
export PATH=/usr/local/opt/llvm/bin:$PATH
|
||||
source scripts/prepare_breakpad_macos.sh
|
||||
mkdir build
|
||||
cd build
|
||||
cmake \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DPYTHON_LIBRARY="$CUTTER_DEPS_PYTHON_PREFIX/lib/libpython3.6m.dylib" \
|
||||
-DPYTHON_INCLUDE_DIR="$CUTTER_DEPS_PYTHON_PREFIX/include/python3.6m" \
|
||||
-DPYTHON_EXECUTABLE="$CUTTER_DEPS_PYTHON_PREFIX/bin/python3" \
|
||||
-DIAITO_ENABLE_PYTHON=ON \
|
||||
-DIAITO_ENABLE_PYTHON_BINDINGS=OFF \
|
||||
-DIAITO_ENABLE_CRASH_REPORTS=ON \
|
||||
-DIAITO_USE_BUNDLED_RADARE2=ON \
|
||||
-DIAITO_ENABLE_PACKAGING=ON \
|
||||
-DIAITO_PACKAGE_DEPENDENCIES=ON \
|
||||
-DIAITO_ENABLE_DEPENDENCY_DOWNLOADS=ON \
|
||||
-DCMAKE_FRAMEWORK_PATH="$BREAKPAD_FRAMEWORK_DIR" \
|
||||
../src && \
|
||||
make -j4;
|
||||
make package
|
||||
export IAITO_VERSION=$(python3 ../scripts/get_version.py)
|
||||
echo PACKAGE_NAME=iaito-mac.tar.gz >> $GITHUB_ENV
|
||||
cd .. && make -C dist/macos
|
||||
- uses: actions/upload-artifact@v2
|
||||
if: contains(matrix.os, 'macos')
|
||||
submodules: false
|
||||
persist-credentials: false
|
||||
- name: Preparing msvc toolchain
|
||||
uses: ilammy/msvc-dev-cmd@v1
|
||||
with:
|
||||
name: iaito-mac.pkg
|
||||
path: dist/macos/macos-pkg/*.pkg
|
||||
- name: windows dependencies
|
||||
if: contains(matrix.os, 'windows-latest')
|
||||
shell: bash
|
||||
run: |
|
||||
pip install ninja
|
||||
scripts/fetch_deps.sh
|
||||
choco install winflexbison3
|
||||
- name: w64-cmake
|
||||
if: contains(matrix.os, 'windows-latest')
|
||||
arch: x64
|
||||
# - uses: actions/setup-python@v5
|
||||
# with:
|
||||
# python-version: 3.11.x
|
||||
# - name: Prepare Qt
|
||||
# working-directory: build
|
||||
# shell: cmd
|
||||
# run: |
|
||||
# curl -vLo qt-unified-windows-x86-online.exe http://download.qt.io/official_releases/online_installers/qt-unified-windows-x86-online.exe
|
||||
# qt-unified-windows-x86-online.exe --verbose --script ..\ci\qt.qs
|
||||
- name: Install Qt
|
||||
uses: jurplel/install-qt-action@v3
|
||||
- name: dependencies
|
||||
shell: cmd
|
||||
run: |
|
||||
set ARCH=x64
|
||||
set IAITO_DEPS=%CD%\cutter-deps
|
||||
set PATH=%CD%\cutter-deps\qt\bin;%CD%\r2_dist\bin;%PATH%
|
||||
call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
|
||||
move radare2 radare2_git
|
||||
call prepare_r2.bat
|
||||
call scripts\prepare_breakpad.bat
|
||||
cd
|
||||
mkdir build
|
||||
cd build
|
||||
set PACKAGE_NAME=iaito-w64
|
||||
cmake ^
|
||||
-DCMAKE_BUILD_TYPE=Release ^
|
||||
-DIAITO_PACKAGE_DEPENDENCIES=ON ^
|
||||
-DIAITO_ENABLE_DEPENDENCY_DOWNLOADS=ON ^
|
||||
-DIAITO_ENABLE_CRASH_REPORTS=ON ^
|
||||
-DCMAKE_PREFIX_PATH="%CUTTER_DEPS%\pyside" ^
|
||||
-DCPACK_PACKAGE_FILE_NAME=%PACKAGE_NAME% ^
|
||||
-G Ninja ^
|
||||
../src
|
||||
cmake --build . --config Release
|
||||
cmake --build . --config Release --target package
|
||||
echo PACKAGE_NAME=%PACKAGE_NAME%.zip >> %GITHUB_ENV%
|
||||
# -DIAITO_ENABLE_PYTHON=ON ^
|
||||
# -DIAITO_ENABLE_PYTHON_BINDINGS=ON ^
|
||||
- uses: actions/upload-artifact@v2
|
||||
if: env.PACKAGE_NAME != null
|
||||
pip install ninja meson wget
|
||||
choco install zip
|
||||
- name: install r2
|
||||
shell: bash
|
||||
run: |
|
||||
python -m wget https://github.com/radareorg/radare2/releases/download/${{env.R2V}}/radare2-${{env.R2V}}-w64.zip -o r2.zip
|
||||
unzip r2.zip
|
||||
mv radare2-${{env.R2V}}-w64 radare2
|
||||
pwd
|
||||
- name: w64-make
|
||||
shell: cmd
|
||||
run: |
|
||||
SET ARCH=x64
|
||||
set PATH=%CD%\r2_dist\bin;%PATH%
|
||||
call preconfigure.bat
|
||||
call configure.bat
|
||||
make.bat
|
||||
- name: dist
|
||||
shell: cmd
|
||||
run: |
|
||||
zip -r iaito.zip iaito
|
||||
dir /s
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: iaito.exe
|
||||
path: iaito\iaito.exe
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: iaito.zip
|
||||
path: iaito.zip
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: ${{ env.PACKAGE_NAME }}
|
||||
path: build/${{ env.PACKAGE_NAME }}
|
||||
|
||||
check_release:
|
||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
|
||||
outputs:
|
||||
is_release: ${{ steps.release.outputs.is }}
|
||||
tag_name: ${{ steps.release.outputs.tag }}
|
||||
needs:
|
||||
- acr-linux
|
||||
- acr-macos-m1
|
||||
- acr-macos-x64
|
||||
- w64-meson
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Download all git history and tags
|
||||
- name: Check if is a release
|
||||
run: git describe --exact-match --tags ${{ github.sha }} | awk 'BEGIN{tag="-";r="no"}/^[0-9]+\.[0-9]+/{tag=$0;r="yes"};END{print "is="r;print "tag="tag}' >> ${GITHUB_OUTPUT}
|
||||
id: release
|
||||
release:
|
||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && needs.check_release.outputs.is_release == 'yes' }}
|
||||
needs:
|
||||
- check_release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Download all git history and tags
|
||||
- name: Extract version
|
||||
run: echo "string=`./configure -qV`" >> $GITHUB_OUTPUT
|
||||
id: version
|
||||
- name: Prepare release notes
|
||||
run: ./scripts/release-notes.sh | tee ./RELEASE_NOTES.md
|
||||
- name: Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: dist/artifacts
|
||||
- name: Display structure of downloaded files
|
||||
run: find dist/artifacts
|
||||
- name: Create GitHub release
|
||||
id: create_release
|
||||
uses: actions/create-release@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag_name: ${{ needs.check_release.outputs.tag_name }}
|
||||
release_name: ${{ steps.version.outputs.string }}
|
||||
body_path: ./RELEASE_NOTES.md
|
||||
draft: false
|
||||
prerelease: false
|
||||
- name: Prepare release notes
|
||||
run: ./scripts/release-notes.sh | tee ./RELEASE_NOTES.md
|
||||
- name: Upload Linux asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/artifacts/iaito-amd64.deb/iaito/iaito_${{ steps.version.outputs.string }}_amd64.deb
|
||||
asset_name: iaito_${{ steps.version.outputs.string }}_amd64.deb
|
||||
asset_content_type: application/vnd.debian.binary-package
|
||||
- name: Upload macOS x64 asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/artifacts/iaito-x64.dmg/iaito.dmg
|
||||
asset_name: iaito_${{ steps.version.outputs.string }}_x64.dmg
|
||||
asset_content_type: application/vnd.debian.binary-package
|
||||
- name: Upload macOS m1 asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/artifacts/iaito-m1.dmg/iaito.dmg
|
||||
asset_name: iaito_${{ steps.version.outputs.string }}_m1.dmg
|
||||
asset_content_type: application/vnd.debian.binary-package
|
||||
- name: Upload Windows QtDeploy asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/artifacts/iaito.zip/iaito.zip
|
||||
asset_name: iaito-${{ steps.version.outputs.string }}-w64.zip
|
||||
asset_content_type: application/zip
|
||||
- name: Upload Windows executable
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/artifacts/iaito.exe/iaito.exe
|
||||
asset_name: iaito-${{ steps.version.outputs.string }}.exe
|
||||
asset_content_type: application/zip
|
||||
@@ -1,65 +0,0 @@
|
||||
name: coverity-scan
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 9 * * 1,5' # Bi-weekly at 09:00 UTC on Monday and Thursday
|
||||
|
||||
jobs:
|
||||
latest:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
with:
|
||||
submodules: true
|
||||
- uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: 3.7.x
|
||||
|
||||
- name: Download Coverity Build Tool
|
||||
run: |
|
||||
wget -q https://scan.coverity.com/download/cxx/linux64 --post-data "token=$TOKEN&project=radareorg%2Fcutter" -O cov-analysis-linux64.tar.gz
|
||||
mkdir cov-analysis-linux64
|
||||
tar xzf cov-analysis-linux64.tar.gz --strip 1 -C cov-analysis-linux64
|
||||
env:
|
||||
TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }}
|
||||
|
||||
- name: Fixed world writable dirs
|
||||
run: |
|
||||
chmod go-w $HOME
|
||||
sudo chmod -R go-w /usr/share
|
||||
|
||||
- name: apt dependencies
|
||||
run: sudo apt-get install ninja-build libgraphviz-dev mesa-common-dev
|
||||
|
||||
- name: py dependencies
|
||||
run: |
|
||||
pip install meson
|
||||
|
||||
- name: CMake
|
||||
run: |
|
||||
scripts/fetch_deps.sh
|
||||
source cutter-deps/env.sh
|
||||
export LD_LIBRARY_PATH="`llvm-config --libdir`:$LD_LIBRARY_PATH"
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -DIAITO_USE_BUNDLED_RADARE2=ON ../src
|
||||
|
||||
- name: Build with cov-build
|
||||
run: |
|
||||
export PATH=`pwd`/cov-analysis-linux64/bin:$PATH
|
||||
cd build
|
||||
cov-build --dir cov-int make
|
||||
|
||||
- name: Submit the result to Coverity Scan
|
||||
run: |
|
||||
cd build
|
||||
tar czvf cutter.tgz cov-int
|
||||
curl \
|
||||
--form project=radareorg-cutter \
|
||||
--form token=$TOKEN \
|
||||
--form [email protected] \
|
||||
--form [email protected] \
|
||||
--form version=trunk \
|
||||
--form description="Iaito" \
|
||||
https://scan.coverity.com/builds?project=radareorg%2Fcutter
|
||||
env:
|
||||
TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }}
|
||||
@@ -0,0 +1,23 @@
|
||||
on:
|
||||
pull_request: {}
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
paths:
|
||||
- .github/workflows/semgrep.yml
|
||||
schedule:
|
||||
# random HH:MM to avoid a load spike on GitHub Actions at 00:00
|
||||
- cron: 45 3 * * *
|
||||
name: Semgrep
|
||||
jobs:
|
||||
semgrep:
|
||||
name: Scan
|
||||
runs-on: ubuntu-20.04
|
||||
env:
|
||||
SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
|
||||
container:
|
||||
image: returntocorp/semgrep
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- run: semgrep ci
|
||||
@@ -1,96 +1,94 @@
|
||||
# Binaries
|
||||
AStyle*
|
||||
|
||||
# OSX files
|
||||
*.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# C++ objects and libs
|
||||
*.slo
|
||||
*.lo
|
||||
*.o
|
||||
*.a
|
||||
*.la
|
||||
*.lai
|
||||
*.so
|
||||
*.dll
|
||||
*.dylib
|
||||
|
||||
# Qt files
|
||||
*.qmake.cache
|
||||
*.qmake.stash
|
||||
*.pro.user
|
||||
*.pro.user.*
|
||||
*.qbs.user
|
||||
*.qbs.user.*
|
||||
*.moc
|
||||
moc_*.cpp
|
||||
qrc_*.cpp
|
||||
moc_*.h
|
||||
ui_*.h
|
||||
build*/
|
||||
cmake-build-*/
|
||||
/src-build/
|
||||
|
||||
# Build folders
|
||||
Debug
|
||||
Release
|
||||
|
||||
# QtCreator
|
||||
*.autosave
|
||||
*.qmlproject.user
|
||||
*.qmlproject.user.*
|
||||
CMakeLists.txt.user
|
||||
|
||||
# CLion
|
||||
.idea
|
||||
|
||||
# Vim
|
||||
*.swp
|
||||
*~
|
||||
|
||||
# Git mergetool
|
||||
~.orig
|
||||
|
||||
# CMake Files:
|
||||
src/*_automoc.cpp
|
||||
*CMakeCache.txt*
|
||||
*cmake_install.cmake*
|
||||
src/CMakeFiles/*
|
||||
|
||||
# Prepare_r2
|
||||
ninja.exe
|
||||
r2_dist_x86/
|
||||
r2_dist_x64/
|
||||
r2_dist/
|
||||
*.pdb
|
||||
|
||||
# Mesonbuild
|
||||
src/subprojects/
|
||||
|
||||
# Python
|
||||
__pycache__
|
||||
/python/
|
||||
|
||||
# Other
|
||||
compile_commands.json
|
||||
.ccls-cache
|
||||
docs/source/_build
|
||||
|
||||
# vscode
|
||||
/.vscode/*
|
||||
!/.vscode/settings.json
|
||||
!/.vscode/extensions.json
|
||||
|
||||
# Visual Studio CMake
|
||||
src/out
|
||||
.vs
|
||||
|
||||
# cutter-deps
|
||||
/cutter-deps
|
||||
|
||||
/breakpad
|
||||
|
||||
# astyle backup .orig files
|
||||
*.orig
|
||||
# Binaries
|
||||
AStyle*
|
||||
|
||||
# OSX files
|
||||
*.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# C++ objects and libs
|
||||
*.slo
|
||||
*.lo
|
||||
*.o
|
||||
*.a
|
||||
*.la
|
||||
*.lai
|
||||
*.so
|
||||
*.dll
|
||||
*.dylib
|
||||
|
||||
# Qt files
|
||||
*.qmake.cache
|
||||
*.qmake.stash
|
||||
*.pro.user
|
||||
*.pro.user.*
|
||||
*.qbs.user
|
||||
*.qbs.user.*
|
||||
*.moc
|
||||
moc_*.cpp
|
||||
qrc_*.cpp
|
||||
moc_*.h
|
||||
ui_*.h
|
||||
build*/
|
||||
cmake-build-*/
|
||||
/src-build
|
||||
|
||||
# Build folders
|
||||
Debug
|
||||
Release
|
||||
|
||||
# QtCreator
|
||||
*.autosave
|
||||
*.qmlproject.user
|
||||
*.qmlproject.user.*
|
||||
CMakeLists.txt.user
|
||||
|
||||
# CLion
|
||||
.idea
|
||||
|
||||
# Vim
|
||||
*.swp
|
||||
*~
|
||||
|
||||
# Git mergetool
|
||||
~.orig
|
||||
|
||||
# CMake Files:
|
||||
src/*_automoc.cpp
|
||||
*CMakeCache.txt*
|
||||
*cmake_install.cmake*
|
||||
src/CMakeFiles/*
|
||||
|
||||
# Prepare_r2
|
||||
ninja.exe
|
||||
r2_dist_x86/
|
||||
r2_dist_x64/
|
||||
r2_dist/
|
||||
*.pdb
|
||||
|
||||
# Mesonbuild
|
||||
src/subprojects/
|
||||
|
||||
# Python
|
||||
__pycache__
|
||||
/python/
|
||||
|
||||
# Other
|
||||
compile_commands.json
|
||||
.ccls-cache
|
||||
docs/source/_build
|
||||
|
||||
# vscode
|
||||
/.vscode/*
|
||||
!/.vscode/settings.json
|
||||
!/.vscode/extensions.json
|
||||
|
||||
# Visual Studio CMake
|
||||
src/out
|
||||
.vs
|
||||
|
||||
# astyle backup .orig files
|
||||
*.orig
|
||||
|
||||
# Translations
|
||||
src/translations
|
||||
@@ -1,6 +0,0 @@
|
||||
[submodule "radare2"]
|
||||
path = radare2
|
||||
url = https://github.com/radareorg/radare2
|
||||
[submodule "src/translations"]
|
||||
path = src/translations
|
||||
url = https://github.com/radareorg/iaito-translations
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"ms-vscode.cpptools",
|
||||
"ms-vscode.cmake-tools",
|
||||
"twxs.cmake"
|
||||
]
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"cmake.sourceDirectory": "${workspaceFolder}/src",
|
||||
"cmake.configureSettings": {
|
||||
"IAITO_USE_BUNDLED_RADARE2": "ON"
|
||||
}
|
||||
}
|
||||
@@ -1,25 +1,30 @@
|
||||
# Contributing to iaito
|
||||
|
||||
Iaito is not in active development, the current focus of the project is in simplicity, reduce
|
||||
tech debt by removing superfluous, anoying or mainly unused dependencies like python support
|
||||
or plugins, breakpad, the cmake build system, crash reports or auto-updates features, as long as
|
||||
the project is under low maintainance mode is good to remove stuff that distract the attention
|
||||
from the core which is the one that should be handling all that stuff. Iaito focus on exposing
|
||||
the capabilities of r2 instead of duplicating efforts in a GUI.
|
||||
|
||||
There are different ways you can help contributing to Iaito:
|
||||
|
||||
## Opening an issue
|
||||
|
||||
Make a clear description of the bug/feature, use screenshots, send binaries, etc.
|
||||
This will help us improve the software for you.
|
||||
You can create an issue by clicking on [this link](https://github.com/radareorg/iaito/issues/new/choose).
|
||||
|
||||
## Submit a Pull Request
|
||||
|
||||
Note that cutter is still under development and many parts of the code are to be improved.
|
||||
The best way is to check the opened issues [here](https://github.com/radareorg/iaito/issues) or discuss with radareorg team.
|
||||
Please follow our contribution guidelines: https://cutter.re/docs/contributing.html
|
||||
If you are feeling brave, create a patch by editing the files in github web interface by pressing the pencil
|
||||
button or fork the repository, create a branch and submit your changes as a pull request.
|
||||
|
||||
## Write Some Documentation
|
||||
|
||||
The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](https://github.com/radareorg/iaito/tree/master/docs) folder.
|
||||
The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
|
||||
Check issues marked as "Documentation" on our issues [list](https://github.com/radareorg/iaito/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation).
|
||||
Feel free to use the radare discord, telegram or irc chats to discuss your ideas, proposals or changes
|
||||
|
||||
## Translations
|
||||
|
||||
You can help Iaito by adding translations to the project! We use the [Crowdin](https://crowdin.com/project/iaito) platform to help us share translations. Feel free to contribute and add translations to the project. If you need to add a language, ask any radareorg developer.
|
||||
Translation files are downloaded from the [Crowdin](https://crowdin.com/project/iaito) platform, where many
|
||||
users can help to review and maintain different languages.
|
||||
|
||||
## Backporting
|
||||
|
||||
It is somewhat desired to backport features or changes already available in Cutter.
|
||||
@@ -6,83 +6,116 @@ else
|
||||
BIN=build/iaito
|
||||
endif
|
||||
|
||||
# linux or win
|
||||
IAITO_OS=macos
|
||||
IAITO_DEPS_URL=https://github.com/rizinorg/cutter-deps/releases/download/v13/cutter-deps-$(IAITO_OS).tar.gz
|
||||
#QMAKE_FLAGS+=IAITO_ENABLE_PYTHON=false
|
||||
QMAKE_FLAGS+=-config release
|
||||
|
||||
#install_name_tool -change /path/to/Qt/lib/QtCore.framework/Versions/4.0/QtCore
|
||||
# @executable_path/../Frameworks/QtCore.framework/Versions/4.0/QtCore
|
||||
# plugandpaint.app/Contents/plugins/libpnp_basictools.dylib
|
||||
|
||||
ifeq ($(WANT_PYTHON),1)
|
||||
QMAKE_FLAGS+=IAITO_ENABLE_PYTHON=true
|
||||
|
||||
# cutter deps should provide deps.mk
|
||||
CMAKE_FLAGS+=-DPYTHON_LIBRARY="$(IAITO_DEPS)/python/lib/libpython3.6m.so.1.0"
|
||||
CMAKE_FLAGS+=-DPYTHON_INCLUDE_DIR="$(IAITO_DEPS)/include/python3.6m"
|
||||
CMAKE_FLAGS+=-DPYTHON_EXECUTABLE="$(IAITO_DEPS)/bin/python3"
|
||||
CMAKE_FLAGS+=-DIAITO_ENABLE_PYTHON=ON
|
||||
CMAKE_FLAGS+=-DIAITO_ENABLE_PYTHON_BINDINGS=ON
|
||||
endif
|
||||
ifeq ($(WANT_PYTHON_BINDINGS),1)
|
||||
QMAKE_FLAGS+=IAITO_ENABLE_PYTHON_BINDINGS=true
|
||||
endif
|
||||
ifeq ($(WANT_CRASH_REPORTS),1)
|
||||
QMAKE_FLAGS+=IAITO_ENABLE_CRASH_REPORTS=true
|
||||
endif
|
||||
QMAKE_FLAGS+=PREFIX=$(PREFIX)
|
||||
|
||||
all: iaito
|
||||
|
||||
cbuild:
|
||||
mkdir -p cbuild
|
||||
cd cbuild && cmake $(CMAKE_FLAGS) \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DIAITO_ENABLE_CRASH_REPORTS=ON \
|
||||
-DIAITO_USE_BUNDLED_RADARE2=OFF \
|
||||
-DIAITO_APPIMAGE_BUILD=ON \
|
||||
-DCMAKE_INSTALL_PREFIX=appdir/usr \
|
||||
../src
|
||||
CXX?=g++
|
||||
|
||||
QTLIBS=$(shell grep "^LIBS" build/Makefile | cut -d = -f 2-)
|
||||
R2LIBS=$(shell pkg-config --cflags --libs r_core)
|
||||
R2_LIBEXT=$(shell r2 -H R2_LIBEXT)
|
||||
R2_USER_PLUGINS=$(shell r2 -H R2_USER_PLUGINS)
|
||||
|
||||
plugin core_plugin: iaito
|
||||
SUBLIBS=true $(CXX) build/*.o src/CorePlugin.cpp -shared -fPIC $(QTLIBS) $(R2LIBS) -o build/CorePlugin.$(R2_LIBEXT)
|
||||
mkdir -p $(R2_USER_PLUGINS)
|
||||
rm -f $(R2_USER_PLUGINS)/IaitoPlugin.$(R2_LIBEXT)
|
||||
cp -f build/CorePlugin.$(R2_LIBEXT) $(R2_USER_PLUGINS)/IaitoPlugin.$(R2_LIBEXT)
|
||||
|
||||
asan:
|
||||
export CXXFLAGS=-fsanitize=address ; \
|
||||
export CFLAGS=-fsanitize=address ; \
|
||||
export LDFLAGS=-fsanitize=address ; \
|
||||
$(MAKE) build && $(MAKE) -C build -j4
|
||||
|
||||
clean:
|
||||
|
||||
mrproper: clean
|
||||
rm -rf build
|
||||
|
||||
.PHONY: cmake install build run user-install clean mrproper translations
|
||||
dist:
|
||||
ifeq ($(shell uname),Darwin)
|
||||
$(MAKE) -C dist/macos
|
||||
else
|
||||
$(MAKE) -C dist/debian
|
||||
endif
|
||||
|
||||
cmake: cbuild
|
||||
$(MAKE)
|
||||
mrproper: clean
|
||||
git clean -xdf
|
||||
|
||||
iaito: translations
|
||||
$(MAKE) -C build -j4
|
||||
|
||||
translations: build src/translations/README.md
|
||||
$(MAKE) -C src/translations
|
||||
# lrelease src/Iaito.pro
|
||||
|
||||
src/translations/README.md:
|
||||
git submodule update --init
|
||||
.PHONY: install run user-install dist macos clean mrproper install-translations
|
||||
|
||||
# force qt5 build when QtCreator is installed in user's home
|
||||
ifeq ($(shell test -x ~/Qt/5.12.3/clang_64/bin/qmake || echo err),)
|
||||
QMAKE=~/Qt/5.12.3/clang_64/bin/qmake
|
||||
ifeq ($(shell test -x ~/Qt/5.*/clang_64/bin/qmake || echo err),)
|
||||
QMAKE=~/Qt/5.*/clang_64/bin/qmake
|
||||
endif
|
||||
|
||||
iaito: build
|
||||
$(MAKE) -C build
|
||||
|
||||
build:
|
||||
mkdir -p build
|
||||
cd build && $(QMAKE) ../src/Iaito.pro $(QMAKE_FLAGS)
|
||||
|
||||
install: translations
|
||||
install-man:
|
||||
mkdir -p "${DESTDIR}${MANDIR}/man1"
|
||||
for FILE in src/*.1 ; do ${INSTALL_MAN} "$$FILE" "${DESTDIR}${MANDIR}/man1" ; done
|
||||
|
||||
install: build
|
||||
ifeq ($(shell uname),Darwin)
|
||||
rm -rf $(DESTDIR)/Applications/iaito.app
|
||||
mkdir -p $(DESTDIR)/Applications
|
||||
cp -rf build/iaito.app $(DESTDIR)/Applications/iaito.app
|
||||
mkdir -p $(DESTDIR)/usr/local/bin
|
||||
ln -fs '/Applications/iaito.app/Contents/MacOS/iaito' $(DESTDIR)'/usr/local/bin/iaito'
|
||||
mkdir -p $(DESTDIR)/$(PREFIX)/bin
|
||||
ln -fs '/Applications/iaito.app/Contents/MacOS/iaito' $(DESTDIR)/$(PREFIX)'/bin/iaito'
|
||||
else
|
||||
$(MAKE) -C build install INSTALL_ROOT=$(DESTDIR)
|
||||
endif
|
||||
$(MAKE) -C src/translations install
|
||||
mkdir -p "$(DESTDIR)/$(PREFIX)/share/iaito/translations"
|
||||
cp -f src/translations/build/*.qm "$(DESTDIR)/$(PREFIX)/share/iaito/translations"
|
||||
$(MAKE) install-man
|
||||
|
||||
user-install:
|
||||
uninstall:
|
||||
ifeq ($(shell uname),Darwin)
|
||||
rm -rf $(DESTDIR)/Applications/iaito.app
|
||||
rm -rf "$(DESTDIR)/$(PREFIX)/bin/iaito"
|
||||
else
|
||||
rm -rf "$(DESTDIR)/$(PREFIX)/share/iaito"
|
||||
rm -rf "$(DESTDIR)/$(PREFIX)/bin/iaito"
|
||||
endif
|
||||
rm -f "${DESTDIR}$(MANDIR)/man1/iaito.1"
|
||||
|
||||
user-install: build
|
||||
ifeq ($(shell uname),Darwin)
|
||||
rm -rf ${HOME}/Applications/iaito.app
|
||||
mkdir -p ${HOME}/Applications
|
||||
cp -rf build/iaito.app ${HOME}/Applications/iaito.app
|
||||
else
|
||||
$(MAKE) -C build install INSTALL_ROOT=/ PREFIX=${HOME}/.local
|
||||
endif
|
||||
$(MAKE) install-man DESTDIR=/ PREFIX=${HOME}/.local MANDIR=${HOME}/.local/share/man
|
||||
|
||||
user-uninstall:
|
||||
$(MAKE) uninstall DESTDIR=/ PREFIX=${HOME}/.local MANDIR=${HOME}/.local/share/man
|
||||
|
||||
run:
|
||||
$(BIN)
|
||||
rarun2 libpath=$(shell r2 -H R2_LIBDIR) program=$(BIN)
|
||||
|
||||
src/translations/README.md:
|
||||
git clone https://github.com/radareorg/iaito-translations.git src/translations
|
||||
|
||||
install-translations: src/translations/README.md
|
||||
$(MAKE) -C src/translations install PREFIX="$(DESTDIR)/$(PREFIX)"
|
||||
|
||||
user-install-translations: src/translations/README.md
|
||||
$(MAKE) -C src/translations user-install
|
||||
@@ -2,69 +2,123 @@
|
||||
|
||||
# iaito
|
||||
|
||||
iaito is the official graphical interface for radare2 written in Qt/C++.
|
||||
|
||||
It is the continuation of [Cutter](https://cutter.re) before the [fork](https://github.com/rizinorg/cutter) to keep [radare2](https://github.com/radareorg/radare2) as backend.
|
||||
iaito is the official graphical interface for radare2, a libre reverse engineering framework.
|
||||
|
||||
* Requires radare2 and Qt-5/6
|
||||
* Iaito was the original name of this GUI before being forked as Cutter.
|
||||
* Support latest versions and features of radare2
|
||||
* Use r2 plugins (f.ex: no need for r2ghidra-iaito plugin if r2ghidra is installed)
|
||||
* Focus on parity of commands and r2-style workflows.
|
||||
* Translations are in the early steps, please [contribute](https://crowdin.com/project/iaito)!
|
||||
* Focus on simplicity, parity with commands, keybindings and r2-style workflows.
|
||||
* Help with translations [contributed](https://crowdin.com/project/iaito)!
|
||||
* Aims to cover other radare2 features, not just a disassembler
|
||||
* forensics, networking, bindiffing, solvers, ...
|
||||
|
||||
[](https://crowdin.com/project/iaito)
|
||||
[](https://github.com/radareorg/iaito/actions)
|
||||
[](https://repology.org/project/iaito/versions)
|
||||
|
||||
|
||||

|
||||
|
||||
## Downloading a release
|
||||
|
||||
iaito is available for Linux, macOS and Windows.
|
||||
Get the builds from the [releases](https://github.com/radareorg/iaito/releases) page in Github.
|
||||
|
||||
## Installing dependencies
|
||||
|
||||
iaito depends on r2, and you should install it from git:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/radareorg/radare2
|
||||
$ cd radare2 ; sys/install.sh
|
||||
```
|
||||
|
||||
Extra dependencies are needed for macOS, see the .github/workflows/ci.yml for more details
|
||||
|
||||
```
|
||||
brew install qt5
|
||||
```
|
||||
|
||||
On Ubuntu/Debian
|
||||
|
||||
```
|
||||
sudo apt install qttools5-dev-tools qt5-default libqt5svg5-dev make
|
||||
```
|
||||
|
||||
## Building from sources
|
||||
|
||||
```
|
||||
./configure
|
||||
make
|
||||
make run
|
||||
```
|
||||
To install the app and the translations in your home:
|
||||
|
||||
```
|
||||
make install
|
||||
```
|
||||
|
||||
## Plugins
|
||||
iaito supports both Python and Native C++ plugins. For now the api is compatible with Iaito. Read the [Plugins](https://cutter.re/docs/plugins) section on their documentation.
|
||||

|
||||
|
||||
## Help
|
||||
|
||||
Get help, updates, meet the community or discuss about development in these channels:
|
||||
|
||||
- **Discord:** [https://discord.gg/6RwDEJFr](https://discord.gg/6RwDEJFr)
|
||||
- **Telegram:** https://t.me/radare
|
||||
- **Mastodon:** [@radareorg](https://infosec.exchange/@radareorg)
|
||||
- **IRC:** #radare on irc.freenode.net
|
||||
- **Twitter:** [@radareorg](https://twitter.com/radareorg)
|
||||
|
||||
## Installation
|
||||
|
||||
There are automated CI builds and [releases](https://github.com/radareorg/iaito/releases) of iaito for Linux, macOS and Windows.
|
||||
|
||||
On WSL or Linux you can use these steps to install it with Flatpak:
|
||||
|
||||
```sh
|
||||
sudo flatpak remote-add flathub https://dl.flathub.org/repo/flathub.flatpakrepo
|
||||
sudo flatpak install flathub org.radare.iaito
|
||||
flatpak run org.radare.iaito
|
||||
```
|
||||
|
||||
<a href='https://flathub.org/apps/details/org.radare.iaito'><img width='120' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
|
||||
|
||||
## Source Builds
|
||||
|
||||
### Dependencies
|
||||
|
||||
iaito requires [radare2](https://github.com/radareorg/radare2) and qt5 (or qt6):
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/radareorg/radare2 && radare2/sys/install.sh
|
||||
```
|
||||
|
||||
Install QT on macOS like this:
|
||||
|
||||
```sh
|
||||
brew install qt@5
|
||||
echo 'export PATH="/opt/homebrew/opt/qt@5/bin:$PATH"' >> ~/.profile
|
||||
```
|
||||
|
||||
On Ubuntu/Debian
|
||||
|
||||
```sh
|
||||
sudo apt install qttools5-dev qttools5-dev-tools qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5svg5-dev make pkg-config build-essential
|
||||
```
|
||||
|
||||
For QT6:
|
||||
|
||||
```sh
|
||||
sudo apt install qt6-svg-dev
|
||||
```
|
||||
|
||||
### Compilation
|
||||
|
||||
```sh
|
||||
./configure
|
||||
make
|
||||
make run
|
||||
```
|
||||
|
||||
To install the app in your home:
|
||||
|
||||
```sh
|
||||
make install
|
||||
```
|
||||
|
||||
### Building iaito as an r2 plugin
|
||||
|
||||
It is also possible to launch iaito from the r2 shell reusing the Core instance:
|
||||
|
||||
```
|
||||
make plugin
|
||||
```
|
||||
|
||||
The previous command will build iaito, the iaito plugin and copy it it into your home plugin directory.
|
||||
|
||||
```
|
||||
$ r2 /bin/ls
|
||||
> iaito
|
||||
...
|
||||
```
|
||||
|
||||
### Translations (Optional)
|
||||
|
||||
Note: The flatpak/flathub version already ships the translations as an optional extension.
|
||||
|
||||
To install translations please download latest version from [iaito-translations](https://github.com/radareorg/iaito-translations) repo.
|
||||
|
||||
To install in your home directory, run the following:
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/radareorg/iaito-translations.git
|
||||
$ cd iaito-translations
|
||||
$ make user-install
|
||||
```
|
||||
|
||||
Alternatively, it this project makefile can be used to install them:
|
||||
|
||||
```sh
|
||||
$ make user-install-translations
|
||||
OR
|
||||
$ make install-translations # to install to system
|
||||
```
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
#
|
||||
# -- pancake
|
||||
|
||||
[ -z "$EDITOR" ] && EDITOR=vim
|
||||
|
||||
r2pm -h >/dev/null 2>&1
|
||||
if [ $? = 0 ]; then
|
||||
echo "Installing the last version of 'acr'..."
|
||||
@@ -22,7 +24,7 @@ else
|
||||
acr -p
|
||||
fi
|
||||
|
||||
. configure
|
||||
. ./configure
|
||||
|
||||
sed \
|
||||
-e "s,^IAITO_VERSION_MAJOR.*,IAITO_VERSION_MAJOR = ${VERSION_MAJOR}," \
|
||||
@@ -31,7 +33,11 @@ sed \
|
||||
< src/Iaito.pro > src/Iaito.pro.sed
|
||||
|
||||
mv src/Iaito.pro.sed src/Iaito.pro
|
||||
|
||||
${EDITOR} .github/workflows/ci.yml
|
||||
echo
|
||||
echo "Press enter and add a new changelog entry for the new Flatpak version"
|
||||
read A
|
||||
${EDITOR} src/org.radare.iaito.appdata.xml
|
||||
#V=`./configure -qV | cut -d - -f -1`
|
||||
# meson rewrite kwargs set project / version "$V"
|
||||
# if [ -n "$1" ]; then
|
||||
|
||||
@@ -1,137 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
# This script is a work in progress
|
||||
|
||||
#### Constants ####
|
||||
ERR=0
|
||||
|
||||
#### User variables ####
|
||||
BUILD="$(pwd)/build"
|
||||
QMAKE_CONF=$*
|
||||
ROOT_DIR=$(pwd)
|
||||
|
||||
check_r2() {
|
||||
r2 -v >/dev/null 2>&1
|
||||
if [ $? = 0 ]; then
|
||||
R2COMMIT=$(r2 -v | tail -n1 | sed "s,commit: \\(.*\\) build.*,\\1,")
|
||||
SUBMODULE=$(git submodule | grep "radare2" | awk '{print $1}')
|
||||
if [ "$R2COMMIT" = "$SUBMODULE" ]; then
|
||||
return 0
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
find_qmake() {
|
||||
qmakepath=$(command -v qmake-qt5)
|
||||
if [ -z "$qmakepath" ]; then
|
||||
qmakepath=$(command -v qmake)
|
||||
fi
|
||||
if [ -z "$qmakepath" ]; then
|
||||
echo "You need qmake to build Iaito."
|
||||
echo "Please make sure qmake is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$qmakepath"
|
||||
}
|
||||
|
||||
find_lrelease() {
|
||||
lreleasepath=$(command -v lrelease-qt5)
|
||||
if [ -z "$lreleasepath" ]; then
|
||||
lreleasepath=$(command -v lrelease)
|
||||
fi
|
||||
if [ -z "$lreleasepath" ]; then
|
||||
echo "You need lrelease to build Iaito."
|
||||
echo "Please make sure lrelease is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$lreleasepath"
|
||||
}
|
||||
|
||||
find_gmake() {
|
||||
gmakepath=$(command -v gmake)
|
||||
if [ -z "$gmakepath" ]; then
|
||||
gmakepath=$(command -v make)
|
||||
fi
|
||||
|
||||
${gmakepath} --help 2>&1 | grep -q gnu
|
||||
if [ $? != 0 ]; then
|
||||
echo "You need GNU make to build Iaito."
|
||||
echo "Please make sure gmake is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$gmakepath"
|
||||
}
|
||||
|
||||
prepare_breakpad() {
|
||||
OS="$(uname -s)"
|
||||
if [ -z "$OS" ]; then
|
||||
echo "Could not identify OS, OSTYPE var is empty. You can try to disable breakpad to avoid this error."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "$OS" = "Linux" ]; then
|
||||
. $ROOT_DIR/scripts/prepare_breakpad_linux.sh
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
elif [ "$OS" = "Darwin" ]; then
|
||||
. $ROOT_DIR/scripts/prepare_breakpad_macos.sh
|
||||
fi
|
||||
}
|
||||
|
||||
# Build radare2
|
||||
check_r2
|
||||
if [ $? -eq 1 ]; then
|
||||
printf "A (new?) version of radare2 will be installed. Do you agree? [Y/n] "
|
||||
read -r answer
|
||||
if [ -z "$answer" ] || [ "$answer" = "Y" ] || [ "$answer" = "y" ]; then
|
||||
R2PREFIX=${1:-"/usr"}
|
||||
git submodule init && git submodule update
|
||||
cd radare2 || exit 1
|
||||
./sys/install.sh "$R2PREFIX"
|
||||
cd ..
|
||||
else
|
||||
echo "Sorry but this script won't work otherwise. Read the README."
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
echo "Correct radare2 version found, skipping..."
|
||||
fi
|
||||
|
||||
# Create translations
|
||||
$(find_lrelease) ./src/Iaito.pro
|
||||
|
||||
# Build
|
||||
if [ "${QMAKE_CONF#*IAITO_ENABLE_CRASH_REPORTS=true}" != "$QMAKE_CONF" ]; then
|
||||
prepare_breakpad
|
||||
fi
|
||||
mkdir -p "$BUILD"
|
||||
cd "$BUILD" || exit 1
|
||||
$(find_qmake) ../src/Iaito.pro "$QMAKE_CONF"
|
||||
$(find_gmake) -j4
|
||||
ERR=$((ERR+$?))
|
||||
|
||||
# Move translations
|
||||
mkdir -p "$(pwd)/translations"
|
||||
find "$ROOT_DIR/src/translations" -maxdepth 1 -type f | grep "cutter_..\.qm" | while read -r SRC_FILE; do
|
||||
mv "$SRC_FILE" "$(pwd)/translations"
|
||||
done
|
||||
|
||||
# Finish
|
||||
if [ ${ERR} -gt 0 ]; then
|
||||
echo "Something went wrong!"
|
||||
else
|
||||
echo "Build complete."
|
||||
printf "This build of Iaito will be installed. Do you agree? [Y/n] "
|
||||
read -r answer
|
||||
if [ -z "$answer" ] || [ "$answer" = "Y" ] || [ "$answer" = "y" ]; then
|
||||
$(find_gmake) install
|
||||
else
|
||||
echo "Binary available at $BUILD/iaito"
|
||||
fi
|
||||
if [ -x '/usr/local/bin/iaito.app/Contents/MacOS/iaito' ]; then
|
||||
ln -fs '/usr/local/bin/iaito.app/Contents/MacOS/iaito' '/usr/local/bin/iaito'
|
||||
fi
|
||||
fi
|
||||
|
||||
cd ..
|
||||
@@ -1,7 +1,11 @@
|
||||
PREFIX=@PREFIX@
|
||||
QMAKE=@QMAKE@
|
||||
LRELEASE=@LRELEASE@
|
||||
QMAKE=@QMAKE_BIN@
|
||||
|
||||
WANT_PYTHON=@WANT_PYTHON@
|
||||
WANT_PYTHON_BINDINGS=@WANT_PYTHON_BINDINGS@
|
||||
WANT_CRASH_REPORTS=@WANT_CRASH_REPORTS@
|
||||
|
||||
DESTDIR?=
|
||||
MANDIR=@MANDIR@
|
||||
INSTALL=@INSTALL@
|
||||
INSTALL_MAN=@INSTALL_MAN@
|
||||
@@ -1,5 +1,5 @@
|
||||
#!/bin/sh
|
||||
# This script was automatically generated by ACR v1.9.8
|
||||
# This script was automatically generated by ACR v2.1.4
|
||||
# @author: pancake <nopcode.org>
|
||||
# @url: http://www.nopcode.org
|
||||
# @repo: git clone https://github.com/radare/acr
|
||||
@@ -18,9 +18,7 @@ control_c() {
|
||||
exit 1
|
||||
}
|
||||
trap control_c 2
|
||||
WANT_PYTHON=0
|
||||
WANT_PYTHON_BINDINGS=0
|
||||
WANT_CRASH_REPORTS=0
|
||||
WANT_QMAKE6=0
|
||||
split_host() {
|
||||
S="$"
|
||||
while : ; do
|
||||
@@ -86,6 +84,7 @@ HOST="${BUILD}"
|
||||
TARGET="${HOST}"
|
||||
ETCDIR="/etc"
|
||||
SYSCONFDIR=""
|
||||
DESCRIPTION=""
|
||||
|
||||
create_environ() {
|
||||
: ${EPREFIX:="${PREFIX}"}
|
||||
@@ -94,6 +93,8 @@ create_environ() {
|
||||
: ${SBINDIR:="${PREFIX}/sbin"}
|
||||
: ${ETCDIR:="${SPREFIX}/etc"}
|
||||
: ${LIBDIR:="${SPREFIX}/lib"}
|
||||
: ${PKGCFG_LIBDIR:='${exec_prefix}/lib'}
|
||||
: ${PKGCFG_INCDIR:='${prefix}/include'}
|
||||
: ${LIBEXECDIR:="${SPREFIX}/libexec"}
|
||||
: ${INCLUDEDIR:="${SPREFIX}/include"}
|
||||
: ${DATADIR:="${SPREFIX}/share"}
|
||||
@@ -112,12 +113,12 @@ done
|
||||
: ${INSTALL_PROGRAM_STRIP:=${INSTALL} -m 755 -s}
|
||||
: ${INSTALL_MAN:=${INSTALL} -m 444}
|
||||
: ${INSTALL_LIB:=${INSTALL} -m 755 -c}
|
||||
PKGNAME='iaito' ; VERSION='5.2.2' ; VERSION_MAJOR=5; VERSION_MINOR=2; VERSION_PATCH=2; VERSION_NUMBER=50202; CONTACT_MAIL="[email protected]" ; CONTACT_NAME="pancake" ; CONTACT="pancake <[email protected]>" ;
|
||||
PKGNAME='iaito' ; VERSION='5.9.4' ; VERSION_MAJOR=5; VERSION_MINOR=9; VERSION_PATCH=4; VERSION_NUMBER=50904; CONTACT_MAIL="[email protected]" ; CONTACT_NAME="pancake" ; CONTACT="pancake <[email protected]>" ;
|
||||
}
|
||||
|
||||
show_usage() {
|
||||
cat <<EOF2
|
||||
'configure' configures iaito-5.2.2 to adapt to many kinds of systems.
|
||||
'configure' configures iaito-5.9.4 to adapt to many kinds of systems.
|
||||
|
||||
Usage: ./configure [OPTION]... [VAR=VALUE]...
|
||||
|
||||
@@ -161,10 +162,7 @@ EOF2
|
||||
|
||||
printf "
|
||||
Optional Features:
|
||||
--with-python build with support for Python
|
||||
--with-python-bindings
|
||||
build with Python bindings
|
||||
--with-crash-reports handle crashes nicely
|
||||
--with-qmake6 ignore qmake in path when qmake6 is found
|
||||
"
|
||||
printf "
|
||||
Some influential environment variables:
|
||||
@@ -196,10 +194,10 @@ ocho() {
|
||||
|
||||
show_version() {
|
||||
if [ "$QUIET" = 1 ]; then
|
||||
echo "5.2.2"
|
||||
echo "5.9.4"
|
||||
exit 0
|
||||
fi
|
||||
echo "iaito-5.2.2 configuration script done with acr v1.9.8.
|
||||
echo "iaito-5.9.4 configuration script done with acr v2.1.4.
|
||||
The 'Free Software Foundation' message is only for autodetection.
|
||||
Originally written by pancake <nopcode.org>."
|
||||
exit 0
|
||||
@@ -227,11 +225,13 @@ case $flag in
|
||||
-V|-version|--version)
|
||||
show_version ; ;;
|
||||
-r|--r|--report)
|
||||
echo "PKGNAME: iaito"
|
||||
echo "VERSION: 5.2.2"
|
||||
echo "LANGS: c++"
|
||||
echo "PKG-CONFIG: r_core"
|
||||
echo "FLAGS: --with-python --with-python-bindings --with-crash-reports"
|
||||
echo "PKGNAME: iaito"
|
||||
echo "VERSION: 5.9.4"
|
||||
echo "AUTHOR: pancake"
|
||||
echo "EMAIL: pancake@nopcode.org"
|
||||
echo "LANGS: c++"
|
||||
echo "PKGCONFIG: r_core"
|
||||
echo "FLAGS: --with-qmake6"
|
||||
exit 0
|
||||
;;
|
||||
--cache-file)
|
||||
@@ -271,19 +271,19 @@ echo "FLAGS: --with-python --with-python-bindings --with-crash-reports"
|
||||
--localstatedir)
|
||||
LOCALSTATEDIR="$value"; ;;
|
||||
--libdir)
|
||||
LIBDIR="$value"; ;;
|
||||
LIBDIR="$value"
|
||||
PKGCFG_LIBDIR="$value"; ;;
|
||||
--libpath)
|
||||
LDFLAGS="${LDFLAGS} ${LIBPATH}$value"; ;;
|
||||
--includedir)
|
||||
PKGCFG_INCDIR="$value"
|
||||
INCLUDEDIR="$value"; CFLAGS="${CFLAGS} -I$value"; ;;
|
||||
--infodir)
|
||||
INFODIR="$value"; ;;
|
||||
--mandir)
|
||||
MANDIR="$value"; ;;
|
||||
|
||||
"--with-python") WANT_PYTHON="1"; ;;
|
||||
"--with-python-bindings") WANT_PYTHON_BINDINGS="1"; ;;
|
||||
"--with-crash-reports") WANT_CRASH_REPORTS="1"; ;;
|
||||
"--with-qmake6") WANT_QMAKE6="1"; ;;
|
||||
*) if [ "$value" ]; then eval "`echo $flag2=$value`" ;
|
||||
else echo ; echo "WARNING: Unknown flag '$flag'." >&2 ; echo ; fi ;;
|
||||
esac
|
||||
@@ -301,7 +301,7 @@ parse_options "$1"
|
||||
shift
|
||||
done
|
||||
|
||||
ENVWORDS="MANDIR INFODIR LIBDIR INCLUDEDIR LOCALSTATEDIR ETCDIR SYSCONFDIR DATADIR DOCDIR LIBEXECDIR SBINDIR BINDIR EPREFIX PREFIX SPREFIX TARGET HOST BUILD INSTALL INSTALL_LIB INSTALL_MAN INSTALL_PROGRAM INSTALL_PROGRAM_STRIP INSTALL_DIR INSTALL_SCRIPT INSTALL_DATA HOST_OS HOST_CPU BUILD_OS BUILD_CPU TARGET_OS TARGET_CPU VERSION VERSION_MAJOR VERSION_MINOR VERSION_PATCH VERSION_NUMBER PKGNAME VPATH CONTACT CONTACT_NAME CONTACT_MAIL CXX CXXFLAGS LDFLAGS HAVE_LANG_CXX CPP PKGCONFIG HAVE_R2 R2 R2_CFLAGS R2_LDFLAGS HAVE_PKGCFG_R_CORE HAVE_QMAKE QMAKE HAVE_LRELEASE LRELEASE WANT_PYTHON WANT_PYTHON_BINDINGS WANT_CRASH_REPORTS"
|
||||
ENVWORDS="MANDIR DESCRIPTION INFODIR LIBDIR INCLUDEDIR LOCALSTATEDIR ETCDIR SYSCONFDIR DATADIR DOCDIR LIBEXECDIR SBINDIR BINDIR EPREFIX PREFIX SPREFIX TARGET HOST BUILD INSTALL INSTALL_LIB INSTALL_MAN INSTALL_PROGRAM INSTALL_PROGRAM_STRIP INSTALL_DIR INSTALL_SCRIPT INSTALL_DATA HOST_OS HOST_CPU BUILD_OS BUILD_CPU TARGET_OS TARGET_CPU VERSION VERSION_MAJOR VERSION_MINOR VERSION_PATCH VERSION_NUMBER PKGCFG_LIBDIR PKGCFG_INCDIR PKGNAME VPATH CONTACT CONTACT_NAME CONTACT_MAIL CXX CXXFLAGS LDFLAGS HAVE_LANG_CXX CPP PKGCONFIG HAVE_R2 R2 R2_CFLAGS R2_LDFLAGS HAVE_PKGCFG_R_CORE HAVE_QMAKE QMAKE HAVE_QMAKE6 QMAKE6 WANT_QMAKE6 QMAKE_BIN WANT_PYTHON WANT_PYTHON_BINDINGS WANT_CRASH_REPORTS"
|
||||
|
||||
create_environ
|
||||
|
||||
@@ -316,8 +316,6 @@ ocho "checking for working directories... ${WODIS}"
|
||||
ocho "using prefix '${PREFIX}'"
|
||||
ACR_RMFILES=" test.c test.cxx a.out a.exe"
|
||||
|
||||
|
||||
|
||||
COMPILER=CXX
|
||||
HAVE_LANG_CXX=1
|
||||
ochof "checking for c++ compiler... "
|
||||
@@ -345,6 +343,7 @@ exit 1
|
||||
if [ 0 = 0 ]; then echo ${CPP}; else
|
||||
echo "ERROR: ${CPP} cannot parse sources"; fi
|
||||
ochof "checking for pkg-config... "
|
||||
ENVWORDS="${ENVWORDS} HAVE_PKGCONFIG"
|
||||
if [ -n "$PKGCONFIG" ]; then
|
||||
if [ -x "$PKGCONFIG" ]; then
|
||||
_HAVE_PKGCONFIG="${PKGCONFIG}"
|
||||
@@ -368,9 +367,12 @@ else
|
||||
fi
|
||||
if [ -n "${PKGCONFIG}" ]; then
|
||||
ocho ${PKGCONFIG}
|
||||
HAVE_PKGCONFIG=1
|
||||
else
|
||||
HAVE_PKGCONFIG=0
|
||||
echo "Cannot find pkg-config or pkgconf in PATH" >&2
|
||||
exit 1 ocho no; fi
|
||||
exit 1
|
||||
ocho no; fi
|
||||
ochof "checking for r2... "
|
||||
if [ -x "${R2}" ]; then
|
||||
FIND=${R2}
|
||||
@@ -439,18 +441,16 @@ if [ "" = 1 ]; then
|
||||
echo "Cannot find qmake" >&2
|
||||
else
|
||||
echo no
|
||||
fi
|
||||
echo "error: This program is required." >&2
|
||||
exit 1 ; fi
|
||||
ochof "checking for lrelease... "
|
||||
if [ -x "${LRELEASE}" ]; then
|
||||
FIND=${LRELEASE}
|
||||
fi ; fi
|
||||
ochof "checking for qmake6... "
|
||||
if [ -x "${QMAKE6}" ]; then
|
||||
FIND=${QMAKE6}
|
||||
else
|
||||
FIND=""
|
||||
IFS=:
|
||||
for A in ${PATH} ; do
|
||||
if [ -x "${A}/lrelease" ]; then
|
||||
FIND="${A}/lrelease"
|
||||
if [ -x "${A}/qmake6" ]; then
|
||||
FIND="${A}/qmake6"
|
||||
break;
|
||||
fi
|
||||
done
|
||||
@@ -458,18 +458,30 @@ else
|
||||
fi
|
||||
if [ -n "${FIND}" ]; then
|
||||
ocho ${FIND};
|
||||
HAVE_LRELEASE=1
|
||||
LRELEASE=${FIND}
|
||||
HAVE_QMAKE6=1
|
||||
QMAKE6=${FIND}
|
||||
else
|
||||
HAVE_LRELEASE=0
|
||||
LRELEASE=lrelease
|
||||
HAVE_QMAKE6=0
|
||||
QMAKE6=qmake6
|
||||
if [ "" = 1 ]; then
|
||||
echo "Cannot find lrelease" >&2
|
||||
echo "Cannot find qmake6" >&2
|
||||
else
|
||||
echo no
|
||||
fi
|
||||
echo "error: This program is required." >&2
|
||||
exit 1 ; fi
|
||||
fi ; fi
|
||||
if [ "$WANT_QMAKE6" = "1" ]; then
|
||||
QMAKE=""; fi
|
||||
if [ "$HAVE_QMAKE" = "1" ]; then
|
||||
QMAKE_BIN="${QMAKE}"
|
||||
else
|
||||
if [ "$HAVE_QMAKE6" = "1" ]; then
|
||||
QMAKE_BIN="${QMAKE6}"
|
||||
else
|
||||
case "$undefined_variable" in 0|"") echo ; echo "ERROR: Missing qmake" >&2 ; echo ; exit 1 ;; esac; fi; fi
|
||||
if [ "$QMAKE_BIN" = """" ]; then
|
||||
case "$undefined_variable" in 0|"") echo ; echo "ERROR: Missing qmake" >&2 ; echo ; exit 1 ;; esac; fi
|
||||
WANT_PYTHON="0"
|
||||
WANT_PYTHON_BINDINGS="0"
|
||||
WANT_CRASH_REPORTS="0"
|
||||
SEDFLAGS=" -e '"
|
||||
COUNT=0
|
||||
for A in ${ENVWORDS} ; do
|
||||
@@ -514,3 +526,12 @@ done
|
||||
done
|
||||
|
||||
do_remove
|
||||
if [ "$QUIET" = 0 ]; then
|
||||
echo
|
||||
echo "Final report:"
|
||||
for A in R2 QMAKE_BIN ; do
|
||||
eval VAL="\$${A}"
|
||||
[ -z "${VAL}" ] && VAL="\"\""
|
||||
echo " - ${A} = ${VAL}"
|
||||
done
|
||||
fi
|
||||
@@ -1,5 +1,5 @@
|
||||
PKGNAME iaito
|
||||
VERSION 5.2.2
|
||||
VERSION 5.9.4
|
||||
CONTACT pancake ; [email protected]
|
||||
|
||||
LANG_CXX!
|
||||
@@ -7,11 +7,38 @@ LANG_CXX!
|
||||
USE_PKGCONFIG!
|
||||
CHKPRG! R2 r2
|
||||
PKGCFG! R2_CFLAGS R2_LDFLAGS r_core
|
||||
CHKPRG! QMAKE qmake
|
||||
CHKPRG! LRELEASE lrelease
|
||||
CHKPRG QMAKE qmake
|
||||
CHKPRG QMAKE6 qmake6
|
||||
(( CHKPRG! LRELEASE lrelease ))
|
||||
|
||||
ARG_WITH WANT_QMAKE6 qmake6 ignore qmake in path when qmake6 is found ;
|
||||
IF WANT_QMAKE6 {
|
||||
QMAKE = "" ;
|
||||
}
|
||||
|
||||
IFEQ HAVE_QMAKE 1 ; {
|
||||
QMAKE_BIN = ${QMAKE} ;
|
||||
}{
|
||||
IFEQ HAVE_QMAKE6 1 ; {
|
||||
QMAKE_BIN = ${QMAKE6} ;
|
||||
}{
|
||||
DIENOW Missing qmake ;
|
||||
}
|
||||
}
|
||||
|
||||
IFEQ QMAKE_BIN "" ; {
|
||||
DIENOW Missing qmake ;
|
||||
}
|
||||
|
||||
WANT_PYTHON = 0 ;
|
||||
WANT_PYTHON_BINDINGS = 0 ;
|
||||
WANT_CRASH_REPORTS = 0 ;
|
||||
((
|
||||
ARG_WITH WANT_PYTHON python build with support for Python ;
|
||||
ARG_WITH WANT_PYTHON_BINDINGS python-bindings build with Python bindings ;
|
||||
ARG_WITH WANT_CRASH_REPORTS crash-reports handle crashes nicely ;
|
||||
))
|
||||
|
||||
SUBDIRS config.mk ;
|
||||
|
||||
REPORT R2 QMAKE_BIN ;
|
||||
@@ -1,46 +1,37 @@
|
||||
@ECHO off
|
||||
SETLOCAL ENABLEDELAYEDEXPANSION
|
||||
SETLOCAL ENABLEEXTENSIONS
|
||||
|
||||
IF "%VisualStudioVersion%" == "14.0" ( IF NOT DEFINED Platform SET "Platform=X86" )
|
||||
FOR /F %%i IN ('powershell -c "\"%Platform%\".toLower()"') DO SET PLATFORM=%%i
|
||||
powershell -c "if ('%PLATFORM%' -notin ('x86', 'x64')) {Exit 1}"
|
||||
IF !ERRORLEVEL! NEQ 0 (
|
||||
ECHO Unknown platform: %PLATFORM%
|
||||
EXIT /B 1
|
||||
)
|
||||
|
||||
SET "R2DIST=r2_dist"
|
||||
SET "BUILDDIR=build_%PLATFORM%"
|
||||
SET "BREAKPAD_SOURCE_DIR=%CD%\src\breakpad\src\src"
|
||||
|
||||
ECHO Preparing directory
|
||||
RMDIR /S /Q %BUILDDIR%
|
||||
MKDIR %BUILDDIR%
|
||||
|
||||
ECHO Prepare translations
|
||||
FOR %%i in (src\translations\*.ts) DO lrelease %%i
|
||||
|
||||
CD %BUILDDIR%
|
||||
|
||||
IF NOT DEFINED IAITO_ENABLE_CRASH_REPORTS (
|
||||
SET "IAITO_ENABLE_CRASH_REPORTS=false"
|
||||
)
|
||||
|
||||
ECHO Building cutter
|
||||
qmake BREAKPAD_SOURCE_DIR=%BREAKPAD_SOURCE_DIR% IAITO_ENABLE_CRASH_REPORTS=%IAITO_ENABLE_CRASH_REPORTS% %* ..\src\cutter.pro -config release
|
||||
IF !ERRORLEVEL! NEQ 0 EXIT /B 1
|
||||
nmake
|
||||
IF !ERRORLEVEL! NEQ 0 EXIT /B 1
|
||||
|
||||
ECHO Deploying cutter
|
||||
MKDIR cutter
|
||||
COPY release\cutter.exe cutter\cutter.exe
|
||||
XCOPY /S /I ..\%R2DIST%\share cutter\share
|
||||
XCOPY /S /I ..\%R2DIST%\lib cutter\lib
|
||||
DEL cutter\lib\*.lib
|
||||
COPY ..\%R2DIST%\bin\*.dll cutter\
|
||||
windeployqt cutter\cutter.exe
|
||||
FOR %%i in (..\src\translations\*.qm) DO MOVE "%%~fi" cutter\translations
|
||||
|
||||
ENDLOCAL
|
||||
@ECHO off
|
||||
SETLOCAL ENABLEDELAYEDEXPANSION
|
||||
SETLOCAL ENABLEEXTENSIONS
|
||||
|
||||
IF "%VisualStudioVersion%" == "14.0" ( IF NOT DEFINED Platform SET "Platform=X86" )
|
||||
FOR /F %%i IN ('powershell -c "\"%Platform%\".toLower()"') DO SET PLATFORM=%%i
|
||||
powershell -c "if ('%PLATFORM%' -notin ('x86', 'x64')) {Exit 1}"
|
||||
IF !ERRORLEVEL! NEQ 0 (
|
||||
ECHO Unknown platform: %PLATFORM%
|
||||
EXIT /B 1
|
||||
)
|
||||
|
||||
SET "R2DIR=radare2"
|
||||
SET "BUILDDIR=build_%PLATFORM%"
|
||||
|
||||
|
||||
ECHO Prepare translations
|
||||
IF NOT EXIST "src\translations\NUL" (
|
||||
git clone https://github.com/radareorg/iaito-translations.git src/translations
|
||||
)
|
||||
FOR %%i in (src\translations\*.ts) DO lrelease %%i
|
||||
|
||||
ECHO Preparing directory
|
||||
rem MOVE radare2 %R2DIR%
|
||||
IF NOT EXIST %BUILDDIR% (
|
||||
MKDIR %BUILDDIR%
|
||||
)
|
||||
CD %BUILDDIR%
|
||||
|
||||
IF NOT DEFINED IAITO_ENABLE_CRASH_REPORTS (
|
||||
SET "IAITO_ENABLE_CRASH_REPORTS=false"
|
||||
)
|
||||
|
||||
ECHO Building iaito
|
||||
qmake BREAKPAD_SOURCE_DIR=%BREAKPAD_SOURCE_DIR% IAITO_ENABLE_CRASH_REPORTS=%IAITO_ENABLE_CRASH_REPORTS% %* ..\src\iaito.pro -config release
|
||||
COPY iaito_resource.rc ..\src
|
||||
IF !ERRORLEVEL! NEQ 0 EXIT /B 1
|
||||
@@ -1,138 +0,0 @@
|
||||
set(IAITO_DEPS "${CMAKE_CURRENT_SOURCE_DIR}/../cutter-deps")
|
||||
unset(RZ_GHIDRA_PREFIX_PATH)
|
||||
|
||||
################################################
|
||||
# Windows
|
||||
################################################
|
||||
|
||||
if(WIN32)
|
||||
set(CPACK_GENERATOR "ZIP")
|
||||
set(RIZIN_INSTALL_PLUGDIR "lib/plugins")
|
||||
|
||||
if (IAITO_PACKAGE_DEPENDENCIES)
|
||||
if (IAITO_ENABLE_PYTHON)
|
||||
if (IAITO_ENABLE_DEPENDENCY_DOWNLOADS)
|
||||
set(CPACK_INSTALL_SCRIPTS ${CMAKE_CURRENT_SOURCE_DIR}/WindowsBundlePython.cmake)
|
||||
endif()
|
||||
find_package(PythonInterp REQUIRED)
|
||||
install(DIRECTORY ${IAITO_DEPS}/pyside/lib/site-packages DESTINATION "python${PYTHON_VERSION_MAJOR}${PYTHON_VERSION_MINOR}")
|
||||
install(FILES ${IAITO_DEPS}/pyside/bin/shiboken2.abi3.dll ${IAITO_DEPS}/pyside/bin/pyside2.abi3.dll DESTINATION .)
|
||||
endif()
|
||||
install(SCRIPT WindowsBundleQt.cmake)
|
||||
endif()
|
||||
if (IAITO_PACKAGE_R2DEC AND IAITO_ENABLE_DEPENDENCY_DOWNLOADS)
|
||||
install(CODE "
|
||||
set(ENV{RZ_ALT_SRC_DIR} 1)
|
||||
set(ENV{PATH} \"\${CMAKE_INSTALL_PREFIX};\$ENV{PATH}\")
|
||||
execute_process(COMMAND powershell \"${CMAKE_CURRENT_SOURCE_DIR}/bundle_r2dec.ps1\" \"\${CMAKE_INSTALL_PREFIX}\"
|
||||
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
||||
RESULT_VARIABLE SCRIPT_RESULT)
|
||||
if (SCRIPT_RESULT)
|
||||
message(FATAL_ERROR \"Failed to package r2dec\")
|
||||
endif()
|
||||
")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
################################################
|
||||
# macOS
|
||||
################################################
|
||||
|
||||
if(APPLE)
|
||||
set(CPACK_GENERATOR "Bundle")
|
||||
set(CPACK_BUNDLE_NAME "iaito")
|
||||
set(ICON "iaito")
|
||||
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/macos/Info.plist.in" "${CMAKE_CURRENT_BINARY_DIR}/macos/Info.plist")
|
||||
set(CPACK_BUNDLE_PLIST "${CMAKE_CURRENT_BINARY_DIR}/macos/Info.plist")
|
||||
set(CPACK_BUNDLE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/macos/cutter.icns")
|
||||
set(CPACK_DMG_BACKGROUND_IMAGE "${CMAKE_CURRENT_SOURCE_DIR}/macos/cutter_mac_app.png")
|
||||
set(CPACK_DMG_DS_STORE "${CMAKE_CURRENT_SOURCE_DIR}/macos/DS_Store_ForDMGBackground")
|
||||
|
||||
|
||||
find_program(MACDEPLOYQT_PATH macdeployqt HINTS "${Qt5_DIR}/../../../bin")
|
||||
if(NOT MACDEPLOYQT_PATH)
|
||||
message(FATAL_ERROR "Failed to find macdeployqt")
|
||||
endif()
|
||||
|
||||
unset(ADJUST_RIZIN_LIBS)
|
||||
foreach(_lib ${RZ_LIBS})
|
||||
list(APPEND ADJUST_RIZIN_LIBS "${RIZIN_INSTALL_DIR}/lib/lib${_lib}.dylib")
|
||||
endforeach()
|
||||
|
||||
if(IAITO_PACKAGE_DEPENDENCIES AND IAITO_ENABLE_PYTHON)
|
||||
set(EMBED_PYTHON_SH "${CMAKE_CURRENT_SOURCE_DIR}/appbundle_embed_python.sh")
|
||||
set(PYTHON_FRAMEWORK_DIR "${IAITO_DEPS}/python/Python.framework")
|
||||
set(PYSIDE_PREFIX "${IAITO_DEPS}/pyside")
|
||||
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/MacOSBundlePython.cmake.in"
|
||||
"${CMAKE_CURRENT_BINARY_DIR}/MacOSBundlePython.cmake" @ONLY)
|
||||
install(SCRIPT "${CMAKE_CURRENT_BINARY_DIR}/MacOSBundlePython.cmake")
|
||||
endif()
|
||||
|
||||
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/MacOSSetupBundle.cmake.in"
|
||||
"${CMAKE_CURRENT_BINARY_DIR}/MacOSSetupBundle.cmake" @ONLY)
|
||||
install(SCRIPT "${CMAKE_CURRENT_BINARY_DIR}/MacOSSetupBundle.cmake")
|
||||
|
||||
get_filename_component(QT_PREFIX "${MACDEPLOYQT_PATH}/../.." ABSOLUTE)
|
||||
list(APPEND RZ_GHIDRA_PREFIX_PATH "${QT_PREFIX}")
|
||||
set(RIZIN_INSTALL_PLUGDIR "share/rizin/plugins") # escaped backslash on purpose, should be evaluated later
|
||||
|
||||
|
||||
endif()
|
||||
|
||||
################################################
|
||||
# rz-ghidra
|
||||
################################################
|
||||
|
||||
if(IAITO_PACKAGE_RZ_GHIDRA)
|
||||
if(IAITO_ENABLE_DEPENDENCY_DOWNLOADS)
|
||||
# Currently using external project only for downloading source
|
||||
# It neeeds to link against compiled cutter so for now build it using custom install script.
|
||||
# That way rz-ghidra build process is the same as with any other external plugin built against
|
||||
# installed Iaito.
|
||||
ExternalProject_Add(rz-ghidra
|
||||
GIT_REPOSITORY https://github.com/rizinorg/rz-ghidra
|
||||
GIT_TAG master
|
||||
CONFIGURE_COMMAND ""
|
||||
BUILD_COMMAND ""
|
||||
INSTALL_COMMAND ""
|
||||
)
|
||||
endif()
|
||||
if (WIN32)
|
||||
set (GHIDRA_OPTIONS "
|
||||
\"-DRIZIN_INSTALL_PLUGDIR=\${CMAKE_INSTALL_PREFIX}/${RIZIN_INSTALL_PLUGDIR}\"
|
||||
-DIAITO_INSTALL_PLUGDIR=plugins/native")
|
||||
elseif (APPLE)
|
||||
set (GHIDRA_OPTIONS "
|
||||
\"-DRIZIN_INSTALL_PLUGDIR=\${CMAKE_INSTALL_PREFIX}/${RIZIN_INSTALL_PLUGDIR}\"
|
||||
-DIAITO_INSTALL_PLUGDIR=plugins/native")
|
||||
else()
|
||||
set (GHIDRA_OPTIONS "")
|
||||
endif()
|
||||
install(CODE "
|
||||
execute_process(
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/rz-ghidra-prefix/src/rz-ghidra-build
|
||||
RESULT_VARIABLE SCRIPT_RESULT
|
||||
COMMAND \${CMAKE_COMMAND}
|
||||
../rz-ghidra
|
||||
-DCMAKE_BUILD_TYPE=Release
|
||||
\"-DCMAKE_PREFIX_PATH=\${CMAKE_INSTALL_PREFIX};\${CMAKE_INSTALL_PREFIX}/include/librz;\${CMAKE_INSTALL_PREFIX}/include/librz/sdb;${RZ_GHIDRA_PREFIX_PATH}\"
|
||||
-DCMAKE_INSTALL_PREFIX=\${CMAKE_INSTALL_PREFIX}
|
||||
${GHIDRA_OPTIONS}
|
||||
-DBUILD_IAITO_PLUGIN=ON
|
||||
-DBUILD_SLEIGH_PLUGIN=OFF
|
||||
-G Ninja
|
||||
)
|
||||
if (SCRIPT_RESULT)
|
||||
message(FATAL_ERROR \"Failed to configure rz-ghidra\")
|
||||
endif()
|
||||
execute_process(WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/rz-ghidra-prefix/src/rz-ghidra-build
|
||||
RESULT_VARIABLE SCRIPT_RESULT
|
||||
COMMAND \${CMAKE_COMMAND} --build . --target install
|
||||
)
|
||||
if (SCRIPT_RESULT)
|
||||
message(FATAL_ERROR \"Failed to install rz-ghidra plugin\")
|
||||
endif()
|
||||
")
|
||||
endif()
|
||||
|
||||
include(CPack)
|
||||
@@ -1,7 +1,7 @@
|
||||
NAME=iaito
|
||||
SECTION=editors
|
||||
PRIORITY=optional
|
||||
DEPENDS=qt5-default libqt5svg5
|
||||
DEPENDS=$(shell ../getpkgversions.sh radare2 libqt5core5a libqt5gui5 libqt5widgets5 libqt5network5 libqt5svg5)
|
||||
MAINTAINER=pancake <[email protected]>
|
||||
ARCH?=amd64
|
||||
VERSION=$(shell ../../../configure -qV)
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
#!/bin/sh
|
||||
for pkg in "$@"
|
||||
do
|
||||
VERSION=$(apt show $pkg 2> /dev/null | grep -F "Version: " | sed -e 's/Version:\s\([[[:digit:]\.]\+\).*/\1/')
|
||||
if [ $pkg != $1 ]; then
|
||||
echo -n ", "
|
||||
fi
|
||||
echo -n "$pkg (>= $VERSION)"
|
||||
done
|
||||
@@ -1,6 +1,5 @@
|
||||
PACKAGE_DIR=$(shell pwd)
|
||||
include ./CONFIG
|
||||
DEPENDS=
|
||||
|
||||
SUDO=fakeroot
|
||||
SUDO=sudo
|
||||
@@ -19,7 +18,7 @@ all:
|
||||
$(MAKE) deb
|
||||
|
||||
root:
|
||||
cd ../../.. && $(MAKE) && $(MAKE) install PREFIX=/usr DESTDIR=/tmp/iaito-deb
|
||||
cd ../../.. && $(MAKE) && $(MAKE) install install-translations PREFIX=/usr DESTDIR=/tmp/iaito-deb
|
||||
mv /tmp/iaito-deb root
|
||||
|
||||
include ../deb_hand.mak
|
||||
@@ -1,2 +1,12 @@
|
||||
all:
|
||||
$(SHELL) make-macos-pkg.sh*
|
||||
rm -f ../../build/iaito.dmg
|
||||
cd ../../build && macdeployqt iaito.app -dmg && cp -f iaito.dmg ../dist/macos
|
||||
|
||||
app:
|
||||
$(SHELL) make-macos-app.sh
|
||||
|
||||
pkg:
|
||||
$(SHELL) make-macos-pkg.sh
|
||||
|
||||
clean:
|
||||
rm -rf macos-pkg tmp
|
||||
@@ -1,11 +1,11 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="no"?>
|
||||
<installer-gui-script minSpecVersion="2">
|
||||
<title>Radare</title>
|
||||
<title>Iaito</title>
|
||||
<license file="COPYING.LESSER" mime-type="text/plain"/>
|
||||
<pkg-ref id="org.radare.iaito">
|
||||
<bundle-version/>
|
||||
</pkg-ref>
|
||||
<options customize="never" require-scripts="false" hostArchitectures="i386,x86_64,arm64"/>
|
||||
<options customize="never" require-scripts="false" hostArchitectures="x86_64,arm64"/>
|
||||
<volume-check>
|
||||
<allowed-os-versions>
|
||||
<os-version min="10.7"/>
|
||||
@@ -22,5 +22,5 @@
|
||||
</choice>
|
||||
<pkg-ref id="org.radare.iaito" version="0" onConclusion="none" installKBytes="51182">#iaito.pkg</pkg-ref>
|
||||
<welcome file="welcome.rtf" mime-type="text/enriched"/>
|
||||
<background file="iaito-o.png" mime-type="image/png" alignment="bottomleft"/>
|
||||
<background file="iaitologo.png" mime-type="image/png" alignment="bottomleft"/>
|
||||
</installer-gui-script>
|
||||
|
After Width: | Height: | Size: 33 KiB |
@@ -7,6 +7,7 @@
|
||||
\f0\fs28 \cf0 \
|
||||
\
|
||||
You will be guided through the steps necessary to\
|
||||
install this software.\
|
||||
install this software. This pkg requires radare2 to\
|
||||
be installed in your system. \
|
||||
\
|
||||
This will install R2 to /usr/}
|
||||
This will install Iaito in /usr/local}
|
||||
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 4.3 KiB |
@@ -0,0 +1,88 @@
|
||||
#!/bin/sh
|
||||
|
||||
SKIPBUILD=0
|
||||
BUNDLE=1
|
||||
|
||||
SRC=/tmp/iaito-macos
|
||||
PREFIX=/usr/local
|
||||
DST="$(pwd)/tmp/iaito.unpkg"
|
||||
if [ -n "$1" ]; then
|
||||
VERSION="$1"
|
||||
else
|
||||
VERSION="`../../configure -qV`"
|
||||
[ -z "${VERSION}" ] && VERSION=5.3.l
|
||||
fi
|
||||
|
||||
[ -z "${MAKE}" ] && MAKE=make
|
||||
|
||||
while : ; do
|
||||
[ -x "$PWD/configure" ] && break
|
||||
[ "$PWD" = / ] && break
|
||||
cd ..
|
||||
done
|
||||
|
||||
[ ! -x "$PWD/configure" ] && exit 1
|
||||
|
||||
pwd
|
||||
if [ ! -d build/iaito.app ]; then
|
||||
rm -rf "${SRC}"
|
||||
${MAKE} mrproper 2>/dev/null
|
||||
# ${MAKE} -j4 || exit 1
|
||||
fi
|
||||
export CFLAGS=-O2
|
||||
if [ "$SKIPBUILD" = 0 ]; then
|
||||
./configure --prefix="${PREFIX}" || exit 1
|
||||
fi
|
||||
${MAKE} install install-translations PREFIX="${PREFIX}" DESTDIR=${SRC} || exit 1
|
||||
mkdir -p "${DST}"
|
||||
echo "DST=$DST"
|
||||
if [ -d "${SRC}" ]; then
|
||||
( # bundle
|
||||
LIBS=`rabin2 -ql ${SRC}/usr/local/bin/iaito | grep -v System`
|
||||
mkdir -p bundle
|
||||
for a in $LIBS ; do
|
||||
echo "LIB $a"
|
||||
D="`basename '$a'`"
|
||||
cp -f $a bundle
|
||||
LIBS2=`rabin2 -ql ${a} | grep -v System`
|
||||
for b in $LIBS2 ; do
|
||||
D2="`basename '$a'`"
|
||||
echo "$a $b"
|
||||
cp $b bundle
|
||||
done
|
||||
done
|
||||
# binary patch the binary
|
||||
echo cp -f ${SRC}/usr/local/bin/iaito bundle/
|
||||
cp -f ${SRC}/usr/local/bin/iaito bundle/
|
||||
for a in bundle/* ; do
|
||||
libs=`rabin2 -ql $a | grep -v System`
|
||||
for b in $libs ; do
|
||||
bn=`basename "$b"`
|
||||
if ls bundle | grep -q "$bn" ; then
|
||||
# its bundled
|
||||
from="$b"
|
||||
to="@executable_path/lib/$bn"
|
||||
echo install_name_tool "$from" "$to" "$a"
|
||||
install_name_tool -change "$from" "$to" "$a"
|
||||
fi
|
||||
done
|
||||
done
|
||||
rm -rf bundle/lib
|
||||
mkdir -p bundle/lib
|
||||
mv bundle/* bundle/lib
|
||||
mv bundle/lib/iaito bundle/
|
||||
# cp -f ${SRC}/usr/local/bin/iaito bundle/
|
||||
exit 1
|
||||
)
|
||||
( # massage
|
||||
cd ${SRC} && find .
|
||||
mv usr/local/share/iaito/translations Applications/iaito.app/Contents/Resources || exit 1
|
||||
cd Applications || exit 1
|
||||
rm -f /tmp/iaito-${VERSION}.zip
|
||||
zip -r /tmp/iaito-${VERSION}.zip iaito.app
|
||||
)
|
||||
mv /tmp/iaito-${VERSION}.zip dist/macos
|
||||
else
|
||||
echo "Failed install. DESTDIR is empty"
|
||||
exit 1
|
||||
fi
|
||||
@@ -5,16 +5,18 @@
|
||||
|
||||
# to uninstall:
|
||||
# sudo pkgutil --forget org.radare.iaito
|
||||
SKIPBUILD=0
|
||||
|
||||
SRC=/tmp/iaito-macos
|
||||
PREFIX=/usr/local
|
||||
DST="$(pwd)/macos-pkg/iaito.unpkg"
|
||||
DST="$(pwd)/tmp/iaito.unpkg"
|
||||
if [ -n "$1" ]; then
|
||||
VERSION="$1"
|
||||
else
|
||||
VERSION="`../../configure -qV`"
|
||||
[ -z "${VERSION}" ] && VERSION=5.2.2
|
||||
[ -z "${VERSION}" ] && VERSION=5.3.l
|
||||
fi
|
||||
|
||||
[ -z "${MAKE}" ] && MAKE=make
|
||||
|
||||
while : ; do
|
||||
@@ -32,18 +34,23 @@ if [ ! -d build/iaito.app ]; then
|
||||
# ${MAKE} -j4 || exit 1
|
||||
fi
|
||||
export CFLAGS=-O2
|
||||
./configure --prefix="${PREFIX}" || exit 1
|
||||
make -C .. translations
|
||||
${MAKE} install PREFIX="${PREFIX}" DESTDIR=${SRC} || exit 1
|
||||
if [ "$SKIPBUILD" = 0 ]; then
|
||||
./configure --prefix="${PREFIX}" || exit 1
|
||||
fi
|
||||
${MAKE} install install-translations PREFIX="${PREFIX}" DESTDIR=${SRC} || exit 1
|
||||
mkdir -p "${DST}"
|
||||
echo "DST=$DST"
|
||||
if [ -d "${SRC}" ]; then
|
||||
(
|
||||
cd ${SRC} && \
|
||||
find . | cpio -o --format odc | gzip -c > "${DST}/Payload"
|
||||
)
|
||||
mkbom ${SRC} "${DST}/Bom"
|
||||
echo mkbom "${SRC}" "${DST}/Bom"
|
||||
mkbom "${SRC}" "${DST}/Bom"
|
||||
cp -rf dist/macos/Metadata/* "${DST}"
|
||||
pwd
|
||||
# Repackage
|
||||
pkgutil --flatten "${DST}" "${DST}/../iaito-${VERSION}.pkg"
|
||||
pkgutil --flatten "${DST}" "${DST}/../../iaito-${VERSION}.pkg"
|
||||
else
|
||||
echo "Failed install. DESTDIR is empty"
|
||||
exit 1
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
sudo: required
|
||||
|
||||
services:
|
||||
- docker
|
||||
|
||||
script:
|
||||
- docker build -t radareorg/cutter .
|
||||
@@ -1,56 +1,56 @@
|
||||
FROM alpine:latest AS builder
|
||||
LABEL maintainer "Philipp Schmied <ps1337@mailbox.org>"
|
||||
LABEL maintainer "pancake <pancake@nopcode.org>"
|
||||
|
||||
# Prevent build fails because of interactive scripts when compiling
|
||||
ENV DEBIAN_FRONTEND noninteractive
|
||||
|
||||
# Dependencies
|
||||
# Dependencies and get, compile and test Iaito from master branch
|
||||
RUN apk add --no-cache \
|
||||
bash \
|
||||
build-base \
|
||||
cmake \
|
||||
curl \
|
||||
git \
|
||||
linux-headers \
|
||||
pkgconfig \
|
||||
python3-dev \
|
||||
qt5-qtbase \
|
||||
qt5-qtsvg-dev \
|
||||
qt5-qttools-dev \
|
||||
unzip \
|
||||
wget
|
||||
|
||||
# Get, compile and test Iaito from master branch
|
||||
RUN git clone --recurse-submodules https://github.com/radareorg/cutter.git /opt/cutter
|
||||
RUN cd /opt/cutter && \
|
||||
yes | bash build.sh && \
|
||||
bash -c 'if [[ ! -x "/opt/cutter/build/Iaito" ]]; then exit -1; fi'
|
||||
bash \
|
||||
build-base \
|
||||
meson \
|
||||
ninja \
|
||||
curl \
|
||||
git \
|
||||
linux-headers \
|
||||
pkgconfig \
|
||||
patch \
|
||||
python3-dev \
|
||||
qt5-qtbase \
|
||||
qt5-qtsvg-dev \
|
||||
qt5-qttools-dev \
|
||||
qtchooser \
|
||||
qt5-qtbase-dev \
|
||||
unzip \
|
||||
zip \
|
||||
wget && \
|
||||
git clone https://github.com/radareorg/iaito.git /opt/iaito && \
|
||||
git clone --recurse-submodules https://github.com/radareorg/radare2 /opt/radare2 && \
|
||||
cd /opt/radare2 && ./sys/install.sh /usr && \
|
||||
cd /opt/iaito && sh configure && make
|
||||
|
||||
FROM alpine:latest AS runner
|
||||
|
||||
# Add the dependencies we need for running
|
||||
RUN apk add --no-cache \
|
||||
bash \
|
||||
libuuid \
|
||||
make \
|
||||
python3 \
|
||||
qt5-qtbase \
|
||||
shadow \
|
||||
su-exec
|
||||
|
||||
# Get the compiled Iaito, r2 libs and bins from the builder
|
||||
COPY --from=builder /opt/cutter /opt/cutter
|
||||
COPY --from=builder /opt/iaito /opt/iaito
|
||||
COPY --from=builder /opt/radare2 /opt/radare2
|
||||
COPY --from=builder /usr/lib /usr/lib
|
||||
COPY --from=builder /usr/share/radare2 /usr/share/radare2
|
||||
RUN cd /opt/cutter/radare2/binr && \
|
||||
|
||||
# Add the dependencies we need for running
|
||||
RUN apk add --no-cache \
|
||||
bash \
|
||||
libuuid \
|
||||
make \
|
||||
python3 \
|
||||
qt5-qtbase \
|
||||
shadow \
|
||||
su-exec && \
|
||||
cd /opt/radare2/binr && \
|
||||
make install && \
|
||||
make symstall install-symlink
|
||||
|
||||
# Add r2 user
|
||||
RUN useradd r2
|
||||
|
||||
# Prepare files to mount configurations later on
|
||||
RUN mkdir /var/sharedFolder && \
|
||||
make symstall install-symlink && \
|
||||
useradd r2 && \
|
||||
mkdir /var/sharedFolder && \
|
||||
mkdir -p /home/r2/.config/radare2 && \
|
||||
touch /home/r2/.radare2rc && \
|
||||
chown -R r2:r2 /var/sharedFolder && \
|
||||
|
||||
@@ -1,70 +0,0 @@
|
||||
FROM alpine:latest AS builder
|
||||
LABEL maintainer "Philipp Schmied <[email protected]>"
|
||||
|
||||
# Prevent build fails because of interactive scripts when compiling
|
||||
ENV DEBIAN_FRONTEND noninteractive
|
||||
|
||||
# Dependencies
|
||||
RUN apk add --no-cache \
|
||||
bash \
|
||||
cmake \
|
||||
curl \
|
||||
g++ \
|
||||
gcc \
|
||||
git \
|
||||
linux-headers \
|
||||
make \
|
||||
pkgconfig \
|
||||
python3-dev \
|
||||
qt5-qtbase \
|
||||
qt5-qtsvg-dev \
|
||||
qt5-qttools-dev \
|
||||
unzip \
|
||||
wget
|
||||
|
||||
# install radare2 first
|
||||
COPY docker/build_radare2.sh /opt/cutter/
|
||||
COPY radare2 /opt/cutter/radare2
|
||||
|
||||
WORKDIR /opt/cutter
|
||||
RUN bash build_radare2.sh
|
||||
|
||||
COPY docker/build_cutter.sh /opt/cutter/
|
||||
COPY scripts /opt/cutter/scripts
|
||||
COPY src /opt/cutter/src
|
||||
|
||||
RUN bash build_cutter.sh && \
|
||||
bash -c 'if [[ ! -x "/opt/cutter/build/Iaito" ]]; then exit -1; fi'
|
||||
|
||||
FROM alpine:latest AS runner
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
|
||||
# Add the dependencies we need for running
|
||||
RUN apk add --no-cache \
|
||||
bash \
|
||||
libuuid \
|
||||
make \
|
||||
python3 \
|
||||
qt5-qtbase \
|
||||
shadow \
|
||||
su-exec
|
||||
|
||||
# Add r2 user
|
||||
RUN useradd r2
|
||||
|
||||
# Prepare files to mount configurations later on
|
||||
RUN mkdir /var/sharedFolder && \
|
||||
mkdir -p /home/r2/.config/radare2 && \
|
||||
touch /home/r2/.radare2rc && \
|
||||
chown -R r2:r2 /var/sharedFolder && \
|
||||
chown -R r2:r2 /home/r2/
|
||||
|
||||
COPY ./docker/entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
|
||||
# Get the compiled Iaito, r2 libs and bins from the builder
|
||||
COPY --from=builder /opt/cutter /opt/cutter
|
||||
COPY --from=builder /usr/lib /usr/lib
|
||||
COPY --from=builder /usr/share/radare2 /usr/share/radare2
|
||||
WORKDIR /opt/cutter/radare2/binr
|
||||
RUN make install && \
|
||||
make symstall install-symlink
|
||||
@@ -14,10 +14,8 @@ ifdef BINARY
|
||||
endif
|
||||
|
||||
VERSION ?= latest
|
||||
IMAGE_NAME ?= radareorg/cutter
|
||||
CONTAINER_NAME ?= cutter
|
||||
|
||||
LOCAL_DEV ?= n
|
||||
IMAGE_NAME ?= radareorg/iaito
|
||||
CONTAINER_NAME ?= iaito
|
||||
|
||||
# This will output the help for each task
|
||||
# thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
||||
@@ -30,10 +28,10 @@ help: ## This help
|
||||
|
||||
# Build the container
|
||||
build: ## Build the container
|
||||
sudo docker build --rm -t $(IMAGE_NAME) $(if $(LOCAL_DEV) == 'y',-f ./Dockerfile-dev ../,.)
|
||||
sudo docker build --network=host --rm -t $(IMAGE_NAME) .
|
||||
|
||||
build-nc: ## Build the container without caching
|
||||
sudo docker build --rm --no-cache -t $(IMAGE_NAME) $(if $(LOCAL_DEV) == 'y',-f ./Dockerfile-dev ../,.)
|
||||
sudo docker build --network=host --rm --no-cache -t $(IMAGE_NAME) .
|
||||
|
||||
run: ## Run container
|
||||
XSOCK=/tmp/.X11-unix && \
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Docker Configuration for Iaito
|
||||
|
||||
These files provide an easy way to deploy *Iaito* in a Docker container. After additional configuration you may want to apply to the `Makefile`, execute `make run`. By default, the *Iaito* image on [Docker Hub](https://hub.docker.com/r/radareorg/cutter/) will be used along with additional UID, capability, X and mount settings:
|
||||
These files provide an easy way to deploy *Iaito* in a Docker container. After additional configuration you may want to apply to the `Makefile`, execute `make run`. By default, the *Iaito* image on [Docker Hub](https://hub.docker.com/r/radareorg/iaito/) will be used along with additional UID, capability, X and mount settings:
|
||||
|
||||
- Xauthority settings which avoid using potentially insecure `xhost` directives. The settings have been adapted from [this post](https://stackoverflow.com/questions/16296753/can-you-run-gui-apps-in-a-docker-container/25280523#25280523).
|
||||
- Mount directives to mount a shared folder and radare2 configuration files.
|
||||
@@ -8,7 +8,7 @@ These files provide an easy way to deploy *Iaito* in a Docker container. After a
|
||||
|
||||
## Using Local Files
|
||||
|
||||
To deploy *Iaito* using local files rather than those in the Master branch set LOCAL_DEV to 'y' when executing `make build` or `make build-nc`, e.g. `make LOCAL_DEV=y build`. This will tell *make* to use `Dockerfile-dev` rather than `Dockerfile` which will copy local files into the container rather than cloning from Git.
|
||||
To deploy *Iaito* using local files rather than those in the Master branch set `LOCAL_DEV` to 'y' when executing `make build` or `make build-nc`, e.g. `make LOCAL_DEV=y build`. This will tell *make* to use `Dockerfile-dev` rather than `Dockerfile` which will copy local files into the container rather than cloning from Git.
|
||||
|
||||
## Mounting and Using a Specific Binary
|
||||
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
# This script is a work in progress
|
||||
|
||||
#### Constants ####
|
||||
ERR=0
|
||||
|
||||
#### User variables ####
|
||||
BUILD="$(pwd)/build"
|
||||
QMAKE_CONF=$*
|
||||
ROOT_DIR=$(pwd)
|
||||
|
||||
find_qmake() {
|
||||
qmakepath=$(command -v qmake-qt5)
|
||||
if [ -z "$qmakepath" ]; then
|
||||
qmakepath=$(command -v qmake)
|
||||
fi
|
||||
if [ -z "$qmakepath" ]; then
|
||||
echo "You need qmake to build Iaito."
|
||||
echo "Please make sure qmake is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$qmakepath"
|
||||
}
|
||||
|
||||
find_lrelease() {
|
||||
lreleasepath=$(command -v lrelease-qt5)
|
||||
if [ -z "$lreleasepath" ]; then
|
||||
lreleasepath=$(command -v lrelease)
|
||||
fi
|
||||
if [ -z "$lreleasepath" ]; then
|
||||
echo "You need lrelease to build Iaito."
|
||||
echo "Please make sure lrelease is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$lreleasepath"
|
||||
}
|
||||
|
||||
find_gmake() {
|
||||
gmakepath=$(command -v gmake)
|
||||
if [ -z "$gmakepath" ]; then
|
||||
gmakepath=$(command -v make)
|
||||
fi
|
||||
|
||||
${gmakepath} --help 2>&1 | grep -q gnu
|
||||
if [ $? != 0 ]; then
|
||||
echo "You need GNU make to build Iaito."
|
||||
echo "Please make sure gmake is in your PATH environment variable."
|
||||
exit 1
|
||||
fi
|
||||
echo "$gmakepath"
|
||||
}
|
||||
|
||||
prepare_breakpad() {
|
||||
OS="$(uname -s)"
|
||||
if [ -z "$OS" ]; then
|
||||
echo "Could not identify OS, OSTYPE var is empty. You can try to disable breakpad to avoid this error."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "$OS" = "Linux" ]; then
|
||||
. $ROOT_DIR/scripts/prepare_breakpad_linux.sh
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
elif [ "$OS" = "Darwin" ]; then
|
||||
. $ROOT_DIR/scripts/prepare_breakpad_macos.sh
|
||||
fi
|
||||
}
|
||||
|
||||
# Create translations
|
||||
$(find_lrelease) ./src/Iaito.pro
|
||||
|
||||
# Build
|
||||
if [ "${QMAKE_CONF#*IAITO_ENABLE_CRASH_REPORTS=true}" != "$QMAKE_CONF" ]; then
|
||||
prepare_breakpad
|
||||
fi
|
||||
mkdir -p "$BUILD"
|
||||
cd "$BUILD" || exit 1
|
||||
$(find_qmake) ../src/Iaito.pro "$QMAKE_CONF"
|
||||
$(find_gmake) -j4
|
||||
ERR=$((ERR+$?))
|
||||
|
||||
# Move translations
|
||||
mkdir -p "$(pwd)/translations"
|
||||
find "$ROOT_DIR/src/translations" -maxdepth 1 -type f | grep "cutter_..\.qm" | while read -r SRC_FILE; do
|
||||
mv "$SRC_FILE" "$(pwd)/translations"
|
||||
done
|
||||
|
||||
# Finish
|
||||
if [ ${ERR} -gt 0 ]; then
|
||||
echo "Something went wrong!"
|
||||
else
|
||||
echo "Build complete."
|
||||
printf "This build of Iaito will be installed. Do you agree? [Y/n] "
|
||||
read -r answer
|
||||
if [ -z "$answer" ] || [ "$answer" = "Y" ] || [ "$answer" = "y" ]; then
|
||||
$(find_gmake) install
|
||||
else
|
||||
echo "Binary available at $BUILD/Iaito"
|
||||
fi
|
||||
fi
|
||||
|
||||
cd ..
|
||||
@@ -1,32 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
check_r2() {
|
||||
r2 -v >/dev/null 2>&1
|
||||
if [ $? = 0 ]; then
|
||||
R2COMMIT=$(r2 -v | tail -n1 | sed "s,commit: \\(.*\\) build.*,\\1,")
|
||||
SUBMODULE=$(git submodule | grep "radare2" | awk '{print $1}')
|
||||
if [ "$R2COMMIT" = "$SUBMODULE" ]; then
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
# Build radare2
|
||||
check_r2
|
||||
if [ $? -eq 1 ]; then
|
||||
printf "A (new?) version of radare2 will be installed. Do you agree? [Y/n] "
|
||||
read -r answer
|
||||
if [ -z "$answer" ] || [ "$answer" = "Y" ] || [ "$answer" = "y" ]; then
|
||||
R2PREFIX=${1:-"/usr"}
|
||||
git submodule init && git submodule update
|
||||
cd radare2 || exit 1
|
||||
./sys/install.sh "$R2PREFIX"
|
||||
cd ..
|
||||
else
|
||||
echo "Sorry but this script won't work otherwise. Read the README."
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
echo "Correct radare2 version found, skipping..."
|
||||
fi
|
||||
@@ -6,4 +6,4 @@ usermod -u $LOCAL_USER_ID $USERNAME
|
||||
usermod -g $LOCAL_GROUP_ID $USERNAME
|
||||
export HOME=/home/$USERNAME
|
||||
|
||||
exec su-exec $USERNAME "/opt/cutter/build/Iaito" $@
|
||||
exec su-exec $USERNAME "/opt/iaito/build/iaito" $@
|
||||
@@ -1,4 +0,0 @@
|
||||
/doxygen-out
|
||||
/build
|
||||
/source/api
|
||||
/source/_build
|
||||
@@ -1,30 +0,0 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
doxygen
|
||||
python3 apidoc.py
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
quick:
|
||||
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
clean:
|
||||
rm -fr doxygen-out
|
||||
rm -fr source/api
|
||||
rm -fr build
|
||||
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
||||
@@ -1,136 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
import os
|
||||
import sys
|
||||
import errno
|
||||
import xml.etree.ElementTree
|
||||
|
||||
|
||||
ALLOWED_TYPES = ['class', 'interface', 'struct', 'union']
|
||||
|
||||
|
||||
def write_file(name, text, destdir):
|
||||
"""Write the output file for module/package <name>."""
|
||||
fname = os.path.join(destdir, '%s.%s' % (name, 'rst'))
|
||||
|
||||
if not os.path.exists(os.path.dirname(fname)):
|
||||
try:
|
||||
os.makedirs(os.path.dirname(fname))
|
||||
except OSError as exc: # Guard against race condition
|
||||
if exc.errno != errno.EEXIST:
|
||||
raise
|
||||
try:
|
||||
with open(fname, 'r') as target:
|
||||
orig = target.read()
|
||||
if orig == text:
|
||||
return
|
||||
except FileNotFoundError:
|
||||
# Don't mind if it isn't there
|
||||
pass
|
||||
|
||||
with open(fname, 'w') as target:
|
||||
target.write(text)
|
||||
|
||||
|
||||
def format_heading(level, text):
|
||||
"""Create a heading of <level> [1, 2 or 3 supported]."""
|
||||
underlining = ['=', '-', '~', ][level - 1] * len(text)
|
||||
return '%s\n%s\n\n' % (text, underlining)
|
||||
|
||||
|
||||
def format_directive(package_type, package, project = None):
|
||||
"""Create the breathe directive and add the options."""
|
||||
directive = '.. doxygen%s:: %s\n' % (package_type, package)
|
||||
if project:
|
||||
directive += ' :project: %s\n' % project
|
||||
return directive
|
||||
|
||||
|
||||
def create_package_file(package, package_type, package_id, package_folder, rootpath, destdir):
|
||||
"""Build the text of the file and write the file."""
|
||||
text = format_heading(1, '%s' % (package))
|
||||
text += format_directive(package_type, package)
|
||||
|
||||
xmlfile = os.path.join(rootpath, package_id + '.xml')
|
||||
f = xml.etree.ElementTree.parse(os.path.join(xmlfile))
|
||||
|
||||
write_file(os.path.join(package_folder, package_id), text, destdir)
|
||||
|
||||
|
||||
def create_modules_toc_file(key, value, destdir):
|
||||
"""Create the module's index."""
|
||||
text = format_heading(1, '%s' % value)
|
||||
text += '.. toctree::\n'
|
||||
text += ' :glob:\n\n'
|
||||
text += ' %s/*\n' % key
|
||||
|
||||
write_file('%slist' % key, text, destdir)
|
||||
|
||||
|
||||
def get_compound_folder(rootpath, compound):
|
||||
fxml = xml.etree.ElementTree.parse(os.path.join(rootpath, compound.get('refid')) + '.xml')
|
||||
loc = fxml.getroot()[0].find('location')
|
||||
dirname = os.path.basename(os.path.split(loc.get('file'))[0])
|
||||
return dirname
|
||||
|
||||
|
||||
def recurse_tree(rootpath, destdir):
|
||||
"""
|
||||
Look for every file in the directory tree and create the corresponding
|
||||
ReST files.
|
||||
"""
|
||||
index = xml.etree.ElementTree.parse(os.path.join(rootpath, 'index.xml'))
|
||||
|
||||
for compound in index.getroot():
|
||||
if compound.get('kind') not in ALLOWED_TYPES:
|
||||
continue
|
||||
create_package_file(compound.findtext('name'), compound.get('kind'),
|
||||
compound.get('refid'), get_compound_folder(rootpath, compound),
|
||||
rootpath, destdir)
|
||||
|
||||
def get_folders_tree(rootpath):
|
||||
tmp = []
|
||||
|
||||
# Retrieve the subfolders indexes
|
||||
for root, _, files in os.walk(rootpath):
|
||||
for xmlfile in files:
|
||||
if not xmlfile.startswith('dir_'):
|
||||
continue
|
||||
tmp.append(xmlfile)
|
||||
|
||||
# Iterate on them
|
||||
dirs = []
|
||||
for xmlfile in tmp:
|
||||
data = xml.etree.ElementTree.parse(os.path.join(rootpath, xmlfile))
|
||||
if not data:
|
||||
continue
|
||||
for compound in data.getroot():
|
||||
name = compound.findtext('compoundname')
|
||||
dirs.append(name)
|
||||
|
||||
return dirs
|
||||
|
||||
|
||||
def main():
|
||||
rootpath = './doxygen-out/xml'
|
||||
destdir = './source/api'
|
||||
|
||||
if not os.path.exists(destdir):
|
||||
os.makedirs(destdir)
|
||||
|
||||
dirs = sorted(get_folders_tree(rootpath))
|
||||
source_root = dirs[0]
|
||||
source_dirs = dirs[1:]
|
||||
out_dirs = [os.path.basename(d) for d in dirs]
|
||||
|
||||
# TODO Handle only one level subfolders
|
||||
for key in out_dirs:
|
||||
ddir = os.path.join(destdir, key)
|
||||
if not os.path.exists(ddir):
|
||||
os.makedirs(ddir)
|
||||
create_modules_toc_file(key, key.capitalize(), destdir)
|
||||
recurse_tree(rootpath, destdir)
|
||||
|
||||
|
||||
# So program can be started with "python -m breathe.apidoc ..."
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -1,51 +0,0 @@
|
||||
{% extends 'basic/layout.html' %}
|
||||
{% block extrahead %}
|
||||
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
|
||||
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
|
||||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
|
||||
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
|
||||
{% endblock %}
|
||||
|
||||
{# https://www.sphinx-doc.org/en/master/templating.html #}
|
||||
|
||||
{% block relbar1 %}{% if pagename != 'index' %}{{ relbar() }}{% endif %}{% endblock %}
|
||||
|
||||
{% block relbar2 %}
|
||||
{% endblock %}
|
||||
|
||||
{% block header %}
|
||||
{% if pagename == 'index' %}<div class=indexwrapper>{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block sidebar1 %}
|
||||
{% endblock %}
|
||||
|
||||
{% block sidebar2 %}
|
||||
{%- if render_sidebar %}
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
{%- block sidebarlogo %}
|
||||
{%- if logo %}
|
||||
<p class="logo"><a href="https://cutter.re/">
|
||||
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
|
||||
</a></p>
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
<a href="{{ pathto(master_doc) }}">{{ project }} documentation</a>
|
||||
{%- if sidebars != None %}
|
||||
{#- new style sidebar: explicitly include/exclude templates #}
|
||||
{%- for sidebartemplate in sidebars %}
|
||||
{%- include sidebartemplate %}
|
||||
{%- endfor %}
|
||||
{%- else %}
|
||||
{#- old style sidebars: using blocks -- should be deprecated #}
|
||||
{%- endif %}
|
||||
</div>
|
||||
</div>
|
||||
{%- endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block footer %}
|
||||
{{ super() }}
|
||||
{% if pagename == 'index' %}</div>{% endif %}
|
||||
{% endblock %}
|
||||
@@ -1,106 +0,0 @@
|
||||
/* Admonition styles */
|
||||
div.admonition {
|
||||
padding: 8px 35px 8px 0px;
|
||||
margin-bottom: 20px;
|
||||
text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
|
||||
border: 1px solid ;
|
||||
color: #3a87ad;
|
||||
background-color: #d9edf7;
|
||||
border-color: #bce8f1;
|
||||
|
||||
-webkit-border-radius: 4px;
|
||||
-moz-border-radius: 4px;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
div.admonition p {
|
||||
margin: 0.5em 1em 0.5em 1em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.admonition pre {
|
||||
margin: 0.4em 1em 0.4em 1em;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
margin: 0;
|
||||
padding: 0.1em 0 0.1em 0.5em;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition ul, div.admonition ol {
|
||||
margin: 0.1em 0.5em 0.5em 3em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/* -- danger, error -- */
|
||||
div.danger,
|
||||
div.error {
|
||||
color: #b94a48;
|
||||
background-color: #f2dede;
|
||||
border-color: #eed3d7;
|
||||
}
|
||||
|
||||
|
||||
/* -- warning, caution, attention -- */
|
||||
div.warning,
|
||||
div.caution,
|
||||
div.attention {
|
||||
color: #c09853;
|
||||
background-color: #fcf8e3;
|
||||
border: 1px solid #fbeed5;
|
||||
}
|
||||
|
||||
/* -- note, important -- */
|
||||
div.note,
|
||||
div.important {
|
||||
color: #468847;
|
||||
background-color: #dff0d8;
|
||||
border-color: #d6e9c6;
|
||||
}
|
||||
|
||||
/* -- hint, tip -- */
|
||||
div.hint,
|
||||
div.tip {
|
||||
color: #3a87ad;
|
||||
background-color: #d9edf7;
|
||||
border-color: #bce8f1;
|
||||
}
|
||||
|
||||
div.danger p.admonition-title:before,
|
||||
div.error p.admonition-title:before,
|
||||
div.warning p.admonition-title:before,
|
||||
div.caution p.admonition-title:before,
|
||||
div.attention p.admonition-title:before,
|
||||
div.important p.admonition-title:before,
|
||||
div.note p.admonition-title:before,
|
||||
div.hint p.admonition-title:before,
|
||||
div.tip p.admonition-title:before
|
||||
{
|
||||
display: inline-block;
|
||||
font-family: FontAwesome;
|
||||
font-style: normal;
|
||||
font-weight: normal;
|
||||
line-height: 1;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
}
|
||||
|
||||
div.danger p.admonition-title:before,
|
||||
div.error p.admonition-title:before {
|
||||
content: "\f06a\00a0";
|
||||
}
|
||||
div.warning p.admonition-title:before,
|
||||
div.caution p.admonition-title:before,
|
||||
div.attention p.admonition-title:before {
|
||||
content: "\f071\00a0";
|
||||
}
|
||||
div.important p.admonition-title:before,
|
||||
div.note p.admonition-title:before {
|
||||
content: "\f05a\00a0";
|
||||
}
|
||||
div.hint p.admonition-title:before,
|
||||
div.tip p.admonition-title:before {
|
||||
content: "\f0eb\00a0";
|
||||
}
|
||||
|
||||
@@ -1,492 +0,0 @@
|
||||
/*
|
||||
* cutter.css_t
|
||||
* based on flasky.css_t by Armin Ronacher
|
||||
* ~~~~~~~~~~~~
|
||||
*
|
||||
*/
|
||||
|
||||
{% set page_width = '1300px' %}
|
||||
{% set sidebar_width = '220px' %}
|
||||
|
||||
@import url('https://fonts.googleapis.com/css?family=Poppins&display=swap');
|
||||
@import url('https://fonts.googleapis.com/css?family=Inconsolata&display=swap');
|
||||
@import url('basic.css');
|
||||
|
||||
/* -- page layout ---------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: "Poppins", sans-serif;
|
||||
font-size: 16px;
|
||||
background-color: white;
|
||||
color: #0d1b33;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: {{ page_width }};
|
||||
margin: 30px auto 0 auto;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 {{ sidebar_width }};
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
width: {{ sidebar_width }};
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #b1b4b6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #fff;
|
||||
color: #3e4349;
|
||||
padding: 0 30px 0 30px;
|
||||
}
|
||||
|
||||
img.floatingflask {
|
||||
padding: 0 0 10px 10px;
|
||||
float: right;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: {{ page_width }};
|
||||
margin: 20px auto 30px auto;
|
||||
font-size: 14px;
|
||||
color: #888;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a:hover {
|
||||
color: #216ae6;
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 18px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.logo {
|
||||
padding: 0 0 20px 0;
|
||||
margin: 0;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: Content-font, Roboto, sans-serif;
|
||||
color: #444;
|
||||
font-size: 18px;
|
||||
font-weight: normal;
|
||||
margin: 0 0 5px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo a,
|
||||
div.sphinxsidebar h3 a,
|
||||
div.sphinxsidebar p.logo a:hover,
|
||||
div.sphinxsidebar h3 a:hover {
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #555;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px 0;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #ccc;
|
||||
font-family: Content-font, Roboto, sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
/* -- body styles ---------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004b6b;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6d4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
color: #041e49;
|
||||
font-family: Content-font, Roboto, sans-serif;
|
||||
font-weight: 400;
|
||||
margin: 30px 0 10px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
{% if theme_index_logo %}
|
||||
div.indexwrapper h1 {
|
||||
text-indent: -999999px;
|
||||
background: url({{ theme_index_logo }}) no-repeat center center;
|
||||
height: {{ theme_index_logo_height }};
|
||||
}
|
||||
{% endif %}
|
||||
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #216ae6;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #041e49;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #faf3e8;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #eee;
|
||||
background: #fdfdfd;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
table.footnote + table.footnote {
|
||||
margin-top: -15px;
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.footnote td.label {
|
||||
width: 0;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.3em 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 0 0 0 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
margin: 10px 0 10px 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #fafafa;
|
||||
padding: 7px 30px;
|
||||
margin: 15px -30px;
|
||||
line-height: 1.3;
|
||||
font-family: 'Inconsolata', monospace;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
color: #e83e8c;
|
||||
word-break: break-word;
|
||||
font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;
|
||||
}
|
||||
|
||||
dl pre, blockquote pre, li pre {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
dl dl pre {
|
||||
margin-left: -90px;
|
||||
padding-left: 90px;
|
||||
}
|
||||
|
||||
a.reference {
|
||||
color: #216ae6;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.reference:hover {
|
||||
color: #216ae6;
|
||||
border-bottom: 1px solid;
|
||||
}
|
||||
|
||||
a.footnote-reference {
|
||||
color: #216ae6;
|
||||
text-decoration: none;
|
||||
font-size: 0.7em;
|
||||
vertical-align: top;
|
||||
border-bottom: 1px solid;
|
||||
}
|
||||
|
||||
a.footnote-reference:hover {
|
||||
color: #216ae6;
|
||||
border-bottom: 1px solid;
|
||||
}
|
||||
|
||||
/* Notes box */
|
||||
.admonition {
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
.admonition.note {
|
||||
color: #0c5460;
|
||||
background-color: #d1ecf1;
|
||||
border-color: #bee5eb;
|
||||
}
|
||||
|
||||
/* API Reference */
|
||||
|
||||
.rst-content dl:not(.docutils) dt {
|
||||
}
|
||||
|
||||
code.descname {
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1050px) {
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 20px 30px;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: none;
|
||||
background: white;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: block;
|
||||
float: none;
|
||||
width: 102.5%;
|
||||
margin: 50px -30px 0;
|
||||
padding: 10px 30px;
|
||||
background: #333;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
|
||||
div.sphinxsidebar h3 a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.related {
|
||||
display: block;
|
||||
margin: 0;
|
||||
padding: 10px 0 20px 0;
|
||||
}
|
||||
|
||||
div.related ul,
|
||||
div.related ul li {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.body {
|
||||
min-height: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.rtd_doc_footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: auto;
|
||||
margin: 0 -30px -20px;
|
||||
padding: 10px 30px 20px;
|
||||
background: #333;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
/* Kbd Style */
|
||||
|
||||
kbd {
|
||||
font-family: Consolas, "Lucida Console", monospace;
|
||||
display: inline-block;
|
||||
border-radius: 3px;
|
||||
padding: 0px 4px;
|
||||
box-shadow: 1px 1px 1px #777;
|
||||
margin: 2px;
|
||||
font-size: small;
|
||||
vertical-align: text-bottom;
|
||||
background: #eee;
|
||||
font-weight: 500;
|
||||
color: #555;
|
||||
cursor: pointer;
|
||||
font-variant: small-caps;
|
||||
font-weight: 600;
|
||||
letter-spacing: 0.5px;
|
||||
letter-spacing: 1px;
|
||||
-webkit-touch-callout: none;
|
||||
-webkit-user-select: none;
|
||||
-khtml-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
kbd:hover,
|
||||
kbd:hover * {
|
||||
color: black;
|
||||
box-shadow: 1px 1px 1px #333;
|
||||
}
|
||||
|
||||
kbd:active,
|
||||
kbd:active * {
|
||||
color: black;
|
||||
box-shadow: 1px 1px 0px #ddd inset;
|
||||
}
|
||||
|
||||
kbd kbd {
|
||||
padding: 0px;
|
||||
margin: 0 1px;
|
||||
box-shadow: 0px 0px 0px black;
|
||||
vertical-align: baseline;
|
||||
background: none;
|
||||
}
|
||||
|
||||
kbd kbd:hover {
|
||||
box-shadow: 0px 0px 0px black;
|
||||
}
|
||||
|
||||
kbd:active kbd {
|
||||
box-shadow: 0px 0px 0px black;
|
||||
background: none;
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
|
||||
// Make sure that external links are opened in new tabs
|
||||
$(document).ready(function() {
|
||||
$("a[href^='http']").attr('target','_blank');
|
||||
});
|
||||
@@ -1,11 +0,0 @@
|
||||
[theme]
|
||||
inherit = basic
|
||||
stylesheet = cutter.css
|
||||
pygments_style = flasky
|
||||
|
||||
[options]
|
||||
index_logo =
|
||||
index_logo_height = 120px
|
||||
touch_icon =
|
||||
github_fork =
|
||||
github_ribbon_color = darkblue_121621
|
||||
@@ -1,664 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
width="95mm"
|
||||
height="60mm"
|
||||
viewBox="0 0 95 60"
|
||||
version="1.1"
|
||||
id="svg8"
|
||||
inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
|
||||
sodipodi:docname="grid.svg">
|
||||
<defs
|
||||
id="defs2">
|
||||
<marker
|
||||
inkscape:isstock="true"
|
||||
style="overflow:visible"
|
||||
id="marker2306"
|
||||
refX="0"
|
||||
refY="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Mend">
|
||||
<path
|
||||
transform="scale(-0.6)"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
id="path2304" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:collect="always"
|
||||
inkscape:stockid="Arrow2Mend"
|
||||
orient="auto"
|
||||
refY="0"
|
||||
refX="0"
|
||||
id="marker1726"
|
||||
style="overflow:visible"
|
||||
inkscape:isstock="true">
|
||||
<path
|
||||
id="path1724"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
transform="scale(-0.6)" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:stockid="Arrow2Mend"
|
||||
orient="auto"
|
||||
refY="0"
|
||||
refX="0"
|
||||
id="marker1388"
|
||||
style="overflow:visible"
|
||||
inkscape:isstock="true">
|
||||
<path
|
||||
id="path1386"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
transform="scale(-0.6)" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:collect="always"
|
||||
inkscape:isstock="true"
|
||||
style="overflow:visible"
|
||||
id="Arrow2Mend"
|
||||
refX="0"
|
||||
refY="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Mend">
|
||||
<path
|
||||
transform="scale(-0.6)"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
id="path1115" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:isstock="true"
|
||||
style="overflow:visible"
|
||||
id="Arrow2Lend"
|
||||
refX="0"
|
||||
refY="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Lend">
|
||||
<path
|
||||
transform="matrix(-1.1,0,0,-1.1,-1.1,0)"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
id="path1109" />
|
||||
</marker>
|
||||
<marker
|
||||
style="overflow:visible"
|
||||
refY="0"
|
||||
refX="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Sstart"
|
||||
inkscape:isstock="true"
|
||||
id="Arrow2Sstart">
|
||||
<path
|
||||
transform="matrix(0.3,0,0,0.3,-0.69,0)"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
id="Arrow2SstartPath"
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z" />
|
||||
</marker>
|
||||
<marker
|
||||
style="overflow:visible"
|
||||
refY="0"
|
||||
refX="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Send"
|
||||
inkscape:isstock="true"
|
||||
id="Arrow2Send">
|
||||
<path
|
||||
transform="matrix(-0.3,0,0,-0.3,0.69,0)"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
id="Arrow2SendPath"
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z" />
|
||||
</marker>
|
||||
<marker
|
||||
id="Arrow2Sstart-1"
|
||||
inkscape:isstock="true"
|
||||
inkscape:stockid="Arrow2Sstart"
|
||||
orient="auto"
|
||||
refX="0"
|
||||
refY="0"
|
||||
style="overflow:visible">
|
||||
<path
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z"
|
||||
id="Arrow2SstartPath-8"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
transform="matrix(0.3,0,0,0.3,-0.69,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
id="Arrow2Send-7"
|
||||
inkscape:isstock="true"
|
||||
inkscape:stockid="Arrow2Send"
|
||||
orient="auto"
|
||||
refX="0"
|
||||
refY="0"
|
||||
style="overflow:visible">
|
||||
<path
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z"
|
||||
id="Arrow2SendPath-9"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
transform="matrix(-0.3,0,0,-0.3,0.69,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:isstock="true"
|
||||
style="overflow:visible"
|
||||
id="marker1726-0"
|
||||
refX="0"
|
||||
refY="0"
|
||||
orient="auto"
|
||||
inkscape:stockid="Arrow2Mend">
|
||||
<path
|
||||
transform="scale(-0.6)"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
id="path1724-2" />
|
||||
</marker>
|
||||
<marker
|
||||
id="Arrow2Sstart-7"
|
||||
inkscape:isstock="true"
|
||||
inkscape:stockid="Arrow2Sstart"
|
||||
orient="auto"
|
||||
refX="0"
|
||||
refY="0"
|
||||
style="overflow:visible">
|
||||
<path
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z"
|
||||
id="Arrow2SstartPath-5"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
transform="matrix(0.3,0,0,0.3,-0.69,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
id="Arrow2Send-9"
|
||||
inkscape:isstock="true"
|
||||
inkscape:stockid="Arrow2Send"
|
||||
orient="auto"
|
||||
refX="0"
|
||||
refY="0"
|
||||
style="overflow:visible">
|
||||
<path
|
||||
d="M 8.72,4.03 -2.21,0.02 8.72,-4 c -1.75,2.37 -1.74,5.62 0,8.03 z"
|
||||
id="Arrow2SendPath-2"
|
||||
style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-opacity:1"
|
||||
transform="matrix(-0.3,0,0,-0.3,0.69,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
inkscape:stockid="Arrow2Mend"
|
||||
orient="auto"
|
||||
refY="0"
|
||||
refX="0"
|
||||
id="marker1726-0-3"
|
||||
style="overflow:visible"
|
||||
inkscape:isstock="true">
|
||||
<path
|
||||
id="path1724-2-6"
|
||||
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
|
||||
d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
|
||||
transform="scale(-0.6)" />
|
||||
</marker>
|
||||
</defs>
|
||||
<sodipodi:namedview
|
||||
fit-margin-bottom="0"
|
||||
fit-margin-right="0"
|
||||
fit-margin-left="0"
|
||||
fit-margin-top="0"
|
||||
inkscape:guide-bbox="true"
|
||||
showguides="true"
|
||||
id="base"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1.0"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:zoom="4"
|
||||
inkscape:cx="233.18761"
|
||||
inkscape:cy="199.03882"
|
||||
inkscape:document-units="mm"
|
||||
inkscape:current-layer="layer1"
|
||||
inkscape:document-rotation="0"
|
||||
showgrid="false"
|
||||
inkscape:window-width="2560"
|
||||
inkscape:window-height="1389"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-maximized="1" />
|
||||
<metadata
|
||||
id="metadata5">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
transform="translate(-28.381867,-41.18436)"
|
||||
inkscape:label="Layer 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1">
|
||||
<text
|
||||
id="text888"
|
||||
y="25.535202"
|
||||
x="31.039022"
|
||||
style="font-style:normal;font-weight:normal;font-size:10.5833px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="25.535202"
|
||||
x="31.039022"
|
||||
id="tspan886"
|
||||
sodipodi:role="line"></tspan></text>
|
||||
<text
|
||||
id="text892"
|
||||
y="54.462158"
|
||||
x="39.601284"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="54.462158"
|
||||
x="39.601284"
|
||||
id="tspan890"
|
||||
sodipodi:role="line"></tspan><tspan
|
||||
id="tspan894"
|
||||
style="stroke-width:0.264583"
|
||||
y="57.989944"
|
||||
x="39.601284"
|
||||
sodipodi:role="line">0</tspan></text>
|
||||
<text
|
||||
id="text898"
|
||||
y="57.95274"
|
||||
x="54.8783"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="57.95274"
|
||||
x="54.8783"
|
||||
id="tspan896"
|
||||
sodipodi:role="line">1</tspan></text>
|
||||
<text
|
||||
id="text902"
|
||||
y="53.987171"
|
||||
x="46.333523"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="53.987171"
|
||||
x="46.333523"
|
||||
id="tspan900"
|
||||
sodipodi:role="line">0</tspan></text>
|
||||
<text
|
||||
id="text906"
|
||||
y="53.949966"
|
||||
x="62.174358"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="53.949966"
|
||||
x="62.174358"
|
||||
id="tspan904"
|
||||
sodipodi:role="line">1</tspan></text>
|
||||
<text
|
||||
id="text910"
|
||||
y="57.989944"
|
||||
x="69.638489"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="57.989944"
|
||||
x="69.638489"
|
||||
id="tspan908"
|
||||
sodipodi:role="line">2</tspan></text>
|
||||
<text
|
||||
id="text914"
|
||||
y="53.987171"
|
||||
x="77.340141"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="53.987171"
|
||||
x="77.340141"
|
||||
id="tspan912"
|
||||
sodipodi:role="line">2</tspan></text>
|
||||
<text
|
||||
id="text918"
|
||||
y="57.989944"
|
||||
x="84.606102"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="57.989944"
|
||||
x="84.606102"
|
||||
id="tspan916"
|
||||
sodipodi:role="line">3</tspan></text>
|
||||
<text
|
||||
id="text922"
|
||||
y="53.987171"
|
||||
x="92.408722"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="53.987171"
|
||||
x="92.408722"
|
||||
id="tspan920"
|
||||
sodipodi:role="line">3</tspan></text>
|
||||
<text
|
||||
id="text926"
|
||||
y="62.487526"
|
||||
x="34.014694"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="62.487526"
|
||||
x="34.014694"
|
||||
id="tspan924"
|
||||
sodipodi:role="line">0</tspan></text>
|
||||
<text
|
||||
id="text930"
|
||||
y="69.829063"
|
||||
x="30.262985"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="69.829063"
|
||||
x="30.262985"
|
||||
id="tspan928"
|
||||
sodipodi:role="line">0</tspan></text>
|
||||
<text
|
||||
id="text934"
|
||||
y="77.488907"
|
||||
x="34.08773"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="77.488907"
|
||||
x="34.08773"
|
||||
id="tspan932"
|
||||
sodipodi:role="line">1</tspan></text>
|
||||
<text
|
||||
id="text938"
|
||||
y="85.418694"
|
||||
x="30.336021"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="85.418694"
|
||||
x="30.336021"
|
||||
id="tspan936"
|
||||
sodipodi:role="line">1</tspan></text>
|
||||
<text
|
||||
id="text942"
|
||||
y="92.507507"
|
||||
x="34.109779"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="92.507507"
|
||||
x="34.109779"
|
||||
id="tspan940"
|
||||
sodipodi:role="line">2</tspan></text>
|
||||
<text
|
||||
id="text958"
|
||||
y="53.987171"
|
||||
x="104.5532"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="53.987171"
|
||||
x="104.5532"
|
||||
id="tspan956"
|
||||
sodipodi:role="line">column</tspan></text>
|
||||
<text
|
||||
id="text962"
|
||||
y="57.442863"
|
||||
x="104.42841"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="57.442863"
|
||||
x="104.42841"
|
||||
id="tspan960"
|
||||
sodipodi:role="line">edge column</tspan></text>
|
||||
<text
|
||||
transform="rotate(90)"
|
||||
id="text966"
|
||||
y="-29.273321"
|
||||
x="43.529709"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="-29.273321"
|
||||
x="43.529709"
|
||||
id="tspan964"
|
||||
sodipodi:role="line">row</tspan></text>
|
||||
<text
|
||||
transform="rotate(90)"
|
||||
id="text970"
|
||||
y="-34.055241"
|
||||
x="43.230721"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="-34.055241"
|
||||
x="43.230721"
|
||||
id="tspan968"
|
||||
sodipodi:role="line">edge row</tspan></text>
|
||||
<rect
|
||||
inkscape:tile-y0="29.999999"
|
||||
inkscape:tile-x0="29.999999"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.0930854;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
id="use986"
|
||||
width="64.899994"
|
||||
height="4.9000001"
|
||||
x="38.048389"
|
||||
y="59.010197" />
|
||||
<rect
|
||||
inkscape:tile-y0="29.999999"
|
||||
inkscape:tile-x0="29.999999"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.0930854;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
id="use988"
|
||||
width="64.899994"
|
||||
height="4.9000001"
|
||||
x="38.048389"
|
||||
y="74.010193" />
|
||||
<rect
|
||||
inkscape:tile-y0="29.999999"
|
||||
inkscape:tile-x0="29.999999"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.0930854;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
id="use990"
|
||||
width="64.899994"
|
||||
height="4.9000001"
|
||||
x="38.048389"
|
||||
y="93.170723" />
|
||||
<rect
|
||||
y="-102.94839"
|
||||
x="59.010201"
|
||||
height="4.9000001"
|
||||
width="39.061729"
|
||||
id="use986-2"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.068298;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
inkscape:tile-x0="29.999999"
|
||||
inkscape:tile-y0="29.999999"
|
||||
transform="rotate(90)" />
|
||||
<rect
|
||||
y="-87.948387"
|
||||
x="59.010201"
|
||||
height="4.9000001"
|
||||
width="39.061729"
|
||||
id="use988-9"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.068298;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
inkscape:tile-x0="29.999999"
|
||||
inkscape:tile-y0="29.999999"
|
||||
transform="rotate(90)" />
|
||||
<rect
|
||||
y="-72.948387"
|
||||
x="59.010201"
|
||||
height="4.9000001"
|
||||
width="39.061729"
|
||||
id="use990-1"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.068298;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
inkscape:tile-x0="29.999999"
|
||||
inkscape:tile-y0="29.999999"
|
||||
transform="rotate(90)" />
|
||||
<rect
|
||||
y="-57.948387"
|
||||
x="59.010201"
|
||||
height="4.9000001"
|
||||
width="39.061729"
|
||||
id="use992-2"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.068298;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
inkscape:tile-x0="29.999999"
|
||||
inkscape:tile-y0="29.999999"
|
||||
transform="rotate(90)" />
|
||||
<rect
|
||||
y="-42.948387"
|
||||
x="59.010201"
|
||||
height="4.9000001"
|
||||
width="39.061729"
|
||||
id="use994-7"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.068298;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
inkscape:tile-x0="29.999999"
|
||||
inkscape:tile-y0="29.999999"
|
||||
transform="rotate(90)" />
|
||||
<rect
|
||||
y="64.578438"
|
||||
x="58.635674"
|
||||
height="8.5201521"
|
||||
width="23.725426"
|
||||
id="rect1026"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.3;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.3;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal"
|
||||
id="rect1026-0"
|
||||
width="23.725426"
|
||||
height="12.675932"
|
||||
x="43.635674"
|
||||
y="79.704514" />
|
||||
<rect
|
||||
y="79.54509"
|
||||
x="73.635674"
|
||||
height="8.5201521"
|
||||
width="23.725426"
|
||||
id="rect1026-0-9"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.3;stroke-miterlimit:4;stroke-dasharray:none;paint-order:normal" />
|
||||
<path
|
||||
sodipodi:nodetypes="ccccc"
|
||||
d="m 69.327077,73.163441 v 3.205877 H 55.388909 v 0 3.30445"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#Arrow2Mend)"
|
||||
id="path1085" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
id="path1384"
|
||||
d="m 71.333422,73.07529 v 3.336512 h 13.367971 v 3.090428"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#marker1388)" />
|
||||
<text
|
||||
id="text1428"
|
||||
y="84.689873"
|
||||
x="81.704636"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="84.689873"
|
||||
x="81.704636"
|
||||
id="tspan1426"
|
||||
sodipodi:role="line">(2, 1)</tspan></text>
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
x="66.704636"
|
||||
y="69.723213"
|
||||
id="text1428-6"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan1426-0"
|
||||
x="66.704636"
|
||||
y="69.723213"
|
||||
style="stroke-width:0.264583">(1, 0)</tspan></text>
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
x="51.704636"
|
||||
y="86.927185"
|
||||
id="text1428-62"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan1426-6"
|
||||
x="51.704636"
|
||||
y="86.927185"
|
||||
style="stroke-width:0.264583">(0, 1)</tspan></text>
|
||||
<path
|
||||
id="path1646"
|
||||
d="m 85.036709,74.435098 -0.0099,1.431015"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-start:url(#Arrow2Sstart);marker-end:url(#Arrow2Send)" />
|
||||
<text
|
||||
id="text1720"
|
||||
y="70.049362"
|
||||
x="100.38699"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
xml:space="preserve"><tspan
|
||||
style="stroke-width:0.264583"
|
||||
y="70.049362"
|
||||
x="100.38699"
|
||||
id="tspan1718"
|
||||
sodipodi:role="line">segment offset</tspan></text>
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
id="path1722"
|
||||
d="M 100.24627,70.152448 85.644108,75.098641"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.264583, 0.529166;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#marker1726)" />
|
||||
<path
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-start:url(#Arrow2Sstart-1);marker-end:url(#Arrow2Send-7)"
|
||||
d="m 68.570639,77.662689 2.143251,0.0099"
|
||||
id="path1646-2" />
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
id="path2057"
|
||||
d="m 71.333422,76.411802 v 1.307449"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.264583, 0.264583;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<path
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.264583, 0.529167;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#marker1726-0)"
|
||||
d="M 100.24627,70.152448 72.043698,77.555282"
|
||||
id="path1722-3"
|
||||
sodipodi:nodetypes="cc" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccccc"
|
||||
id="path2302"
|
||||
d="m 85.503654,88.13046 0.02905,1.836997 h 13.86685 V 76.894177 H 87.138853 v 2.494365"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#marker2306)" />
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-start:url(#Arrow2Sstart-7);marker-end:url(#Arrow2Send-9)"
|
||||
d="m 88.729129,90.472837 -0.0099,2.246409"
|
||||
id="path1646-28" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-size:2.82223px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;stroke-width:0.264583"
|
||||
x="101.43018"
|
||||
y="90.213501"
|
||||
id="text1720-9"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan1718-7"
|
||||
x="101.43018"
|
||||
y="90.213501"
|
||||
style="stroke-width:0.264583">negative</tspan><tspan
|
||||
id="tspan2627"
|
||||
sodipodi:role="line"
|
||||
x="101.43018"
|
||||
y="93.741287"
|
||||
style="stroke-width:0.264583">segment offset</tspan></text>
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
id="path1722-3-1"
|
||||
d="M 102.58403,91.354862 89.524132,91.884014"
|
||||
style="fill:none;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.264583, 0.529167;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#marker1726-0-3)" />
|
||||
</g>
|
||||
<g
|
||||
transform="translate(-28.381867,-41.18436)"
|
||||
style="display:inline"
|
||||
inkscape:label="Layer 2"
|
||||
id="layer2"
|
||||
inkscape:groupmode="layer" />
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 58 KiB |
@@ -1,543 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
|
||||
sodipodi:docname="layout_compacting.svg"
|
||||
id="svg33"
|
||||
viewBox="0 0 266.6575 152.92204"
|
||||
version="1.2"
|
||||
height="203.89606"
|
||||
width="355.54333">
|
||||
<metadata
|
||||
id="metadata37">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<sodipodi:namedview
|
||||
lock-margins="true"
|
||||
fit-margin-bottom="10"
|
||||
fit-margin-right="10"
|
||||
fit-margin-left="10"
|
||||
fit-margin-top="10"
|
||||
inkscape:current-layer="svg33"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-x="0"
|
||||
inkscape:cy="120.22566"
|
||||
inkscape:cx="319.30409"
|
||||
inkscape:zoom="2.4621622"
|
||||
inkscape:snap-midpoints="true"
|
||||
inkscape:guide-bbox="true"
|
||||
showguides="true"
|
||||
inkscape:snap-object-midpoints="true"
|
||||
showgrid="false"
|
||||
id="namedview35"
|
||||
inkscape:window-height="1390"
|
||||
inkscape:window-width="2560"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:pageopacity="0"
|
||||
guidetolerance="10"
|
||||
gridtolerance="10"
|
||||
objecttolerance="10"
|
||||
borderopacity="1"
|
||||
bordercolor="#666666"
|
||||
pagecolor="#ffffff" />
|
||||
<defs
|
||||
id="defs11">
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2914">
|
||||
<path
|
||||
id="path2"
|
||||
stroke-width="1pt"
|
||||
stroke="#005f87"
|
||||
fill-rule="evenodd"
|
||||
fill="#005f87"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2850">
|
||||
<path
|
||||
id="path5"
|
||||
stroke-width="1pt"
|
||||
stroke="#5f8700"
|
||||
fill-rule="evenodd"
|
||||
fill="#5f8700"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2786">
|
||||
<path
|
||||
id="path8"
|
||||
stroke-width="1pt"
|
||||
stroke="#e03030"
|
||||
fill-rule="evenodd"
|
||||
fill="#e03030"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2786-3"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#e03030"
|
||||
fill-rule="evenodd"
|
||||
stroke="#e03030"
|
||||
stroke-width="1pt"
|
||||
id="path8-6" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2850-7"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#5f8700"
|
||||
fill-rule="evenodd"
|
||||
stroke="#5f8700"
|
||||
stroke-width="1pt"
|
||||
id="path5-5" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2914-1"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#005f87"
|
||||
fill-rule="evenodd"
|
||||
stroke="#005f87"
|
||||
stroke-width="1pt"
|
||||
id="path2-2" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2914-1-3">
|
||||
<path
|
||||
id="path2-2-6"
|
||||
stroke-width="1pt"
|
||||
stroke="#005f87"
|
||||
fill-rule="evenodd"
|
||||
fill="#005f87"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2914-1-6">
|
||||
<path
|
||||
id="path2-2-2"
|
||||
stroke-width="1pt"
|
||||
stroke="#005f87"
|
||||
fill-rule="evenodd"
|
||||
fill="#005f87"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2914-8"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#005f87"
|
||||
fill-rule="evenodd"
|
||||
stroke="#005f87"
|
||||
stroke-width="1pt"
|
||||
id="path2-7" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2786-9"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#e03030"
|
||||
fill-rule="evenodd"
|
||||
stroke="#e03030"
|
||||
stroke-width="1pt"
|
||||
id="path8-2" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2850-0"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#5f8700"
|
||||
fill-rule="evenodd"
|
||||
stroke="#5f8700"
|
||||
stroke-width="1pt"
|
||||
id="path5-2" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2786-3-3">
|
||||
<path
|
||||
id="path8-6-6"
|
||||
stroke-width="1pt"
|
||||
stroke="#e03030"
|
||||
fill-rule="evenodd"
|
||||
fill="#e03030"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2850-7-1">
|
||||
<path
|
||||
id="path5-5-2"
|
||||
stroke-width="1pt"
|
||||
stroke="#5f8700"
|
||||
fill-rule="evenodd"
|
||||
fill="#5f8700"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
orient="auto"
|
||||
overflow="visible"
|
||||
id="marker2914-1-9">
|
||||
<path
|
||||
id="path2-2-3"
|
||||
stroke-width="1pt"
|
||||
stroke="#005f87"
|
||||
fill-rule="evenodd"
|
||||
fill="#005f87"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2914-1-3-1"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#005f87"
|
||||
fill-rule="evenodd"
|
||||
stroke="#005f87"
|
||||
stroke-width="1pt"
|
||||
id="path2-2-6-9" />
|
||||
</marker>
|
||||
<marker
|
||||
id="marker2914-1-6-4"
|
||||
overflow="visible"
|
||||
orient="auto">
|
||||
<path
|
||||
transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
|
||||
d="M 0,0 5,-5 -12.5,0 5,5 Z"
|
||||
fill="#005f87"
|
||||
fill-rule="evenodd"
|
||||
stroke="#005f87"
|
||||
stroke-width="1pt"
|
||||
id="path2-2-2-7" />
|
||||
</marker>
|
||||
</defs>
|
||||
<rect
|
||||
x="19.86875"
|
||||
y="20.397875"
|
||||
width="101.07"
|
||||
height="13.331"
|
||||
stroke-width="0.1395"
|
||||
id="rect13"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<rect
|
||||
id="rect15"
|
||||
height="9.3690996"
|
||||
width="24.597"
|
||||
y="38.912872"
|
||||
x="58.105747"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<rect
|
||||
id="rect17"
|
||||
height="9.3690996"
|
||||
width="24.597"
|
||||
y="52.641872"
|
||||
x="7.5697498"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<rect
|
||||
id="rect19"
|
||||
height="9.3690996"
|
||||
width="24.597"
|
||||
y="52.641872"
|
||||
x="108.64275"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<path
|
||||
d="m 70.404751,33.721873 v 5.2398"
|
||||
marker-end="url(#marker2914)"
|
||||
stroke="#005f87"
|
||||
stroke-width="0.75px"
|
||||
id="path25"
|
||||
style="fill:none" />
|
||||
<path
|
||||
d="m 68.750751,48.243873 v 1.8828 h -48.882 v 2.5231"
|
||||
marker-end="url(#marker2786)"
|
||||
stop-color="#000000"
|
||||
stroke="#e03030"
|
||||
stroke-miterlimit="2"
|
||||
stroke-width="0.75"
|
||||
style="font-variation-settings:normal;fill:none"
|
||||
id="path27" />
|
||||
<path
|
||||
d="m 71.872751,48.256873 v 1.8696 h 49.067999 v 3.2324"
|
||||
marker-end="url(#marker2850)"
|
||||
stroke="#5f8700"
|
||||
stroke-width="0.75px"
|
||||
id="path29"
|
||||
style="fill:none" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="206.91023"
|
||||
y="7.5697498"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect15-3" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="181.84999"
|
||||
y="20.957253"
|
||||
width="24.596998"
|
||||
height="28.024694"
|
||||
id="rect17-5" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="234.49074"
|
||||
y="21.999752"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
id="path27-2"
|
||||
style="font-variation-settings:normal;fill:none;marker-end:url(#marker2786-3)"
|
||||
stroke-width="0.75"
|
||||
stroke-miterlimit="2"
|
||||
stroke="#e03030"
|
||||
stop-color="#000000"
|
||||
marker-end="url(#marker2786-3)"
|
||||
d="m 217.55525,16.90075 v 1.8828 h -24.43006 v 2.5231" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
style="fill:none;marker-end:url(#marker2850-7)"
|
||||
id="path29-9"
|
||||
stroke-width="0.75px"
|
||||
stroke="#5f8700"
|
||||
marker-end="url(#marker2850-7)"
|
||||
d="m 220.67725,16.91375 v 1.8696 h 26.11198 v 3.2324" />
|
||||
<rect
|
||||
id="rect19-6-0"
|
||||
height="9.3690987"
|
||||
width="24.596998"
|
||||
y="54.221745"
|
||||
x="181.84999"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<path
|
||||
style="fill:none;marker-end:url(#marker2914-1)"
|
||||
id="path25-7"
|
||||
stroke-width="0.75px"
|
||||
stroke="#005f87"
|
||||
marker-end="url(#marker2914-1)"
|
||||
d="m 194.14849,48.981943 v 5.2398" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="234.49074"
|
||||
y="54.221745"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6-0-9" />
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
d="M 246.78923,31.368849 V 54.148584"
|
||||
marker-end="url(#marker2914-1-3)"
|
||||
stroke="#005f87"
|
||||
stroke-width="0.75px"
|
||||
id="path25-7-0"
|
||||
style="fill:none;marker-end:url(#marker2914-1-3)" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="234.49074"
|
||||
y="68.830635"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6-0-6" />
|
||||
<path
|
||||
d="m 246.78923,63.590837 v 5.2398"
|
||||
marker-end="url(#marker2914-1-6)"
|
||||
stroke="#005f87"
|
||||
stroke-width="0.75px"
|
||||
id="path25-7-1"
|
||||
style="fill:none;marker-end:url(#marker2914-1-6)" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
id="rect13-3"
|
||||
stroke-width="0.1395"
|
||||
height="13.330999"
|
||||
width="101.06999"
|
||||
y="86.583054"
|
||||
x="21.267822" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="59.50481"
|
||||
y="105.09805"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect15-7" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="45.492069"
|
||||
y="120.35294"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect17-59" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="73.206848"
|
||||
y="120.35294"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-2" />
|
||||
<path
|
||||
style="fill:none;marker-end:url(#marker2914-8)"
|
||||
id="path25-2"
|
||||
stroke-width="0.75px"
|
||||
stroke="#005f87"
|
||||
marker-end="url(#marker2914-8)"
|
||||
d="m 71.803816,99.907053 v 5.239787" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
id="path27-8"
|
||||
style="font-variation-settings:normal;fill:none;marker-end:url(#marker2786-9)"
|
||||
stroke-width="0.75"
|
||||
stroke-miterlimit="2"
|
||||
stroke="#e03030"
|
||||
stop-color="#000000"
|
||||
marker-end="url(#marker2786-9)"
|
||||
d="m 70.149816,114.42904 v 1.8828 H 57.91528 v 3.82797" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
style="fill:none;marker-end:url(#marker2850-0)"
|
||||
id="path29-97"
|
||||
stroke-width="0.75px"
|
||||
stroke="#5f8700"
|
||||
marker-end="url(#marker2850-0)"
|
||||
d="m 73.271816,114.44204 v 1.8696 h 12.721232 v 3.23241" />
|
||||
<g
|
||||
transform="translate(-35.90579,-13.250133)"
|
||||
id="g1598">
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="241.84329"
|
||||
y="102.58134"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect15-3-8" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="216.78305"
|
||||
y="115.96884"
|
||||
width="24.596998"
|
||||
height="28.024693"
|
||||
id="rect17-5-4" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="269.4238"
|
||||
y="117.01134"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6-5" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
id="path27-2-0"
|
||||
style="font-variation-settings:normal;fill:none;marker-end:url(#marker2786-3-3)"
|
||||
stroke-width="0.75"
|
||||
stroke-miterlimit="2"
|
||||
stroke="#e03030"
|
||||
stop-color="#000000"
|
||||
marker-end="url(#marker2786-3-3)"
|
||||
d="m 252.48832,111.91234 v 1.8828 h -24.43006 v 2.5231" />
|
||||
<path
|
||||
sodipodi:nodetypes="cccc"
|
||||
style="fill:none;marker-end:url(#marker2850-7-1)"
|
||||
id="path29-9-3"
|
||||
stroke-width="0.75px"
|
||||
stroke="#5f8700"
|
||||
marker-end="url(#marker2850-7-1)"
|
||||
d="m 255.61032,111.92534 v 1.8696 h 26.11198 v 3.2324" />
|
||||
<rect
|
||||
id="rect19-6-0-61"
|
||||
height="9.3690987"
|
||||
width="24.596998"
|
||||
y="149.23332"
|
||||
x="216.78305"
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel" />
|
||||
<path
|
||||
style="fill:none;marker-end:url(#marker2914-1-9)"
|
||||
id="path25-7-06"
|
||||
stroke-width="0.75px"
|
||||
stroke="#005f87"
|
||||
marker-end="url(#marker2914-1-9)"
|
||||
d="m 229.08156,143.99353 v 5.2398" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="269.4238"
|
||||
y="130.94421"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6-0-9-3" />
|
||||
<path
|
||||
sodipodi:nodetypes="cc"
|
||||
d="m 281.7223,126.38044 v 4.19969"
|
||||
marker-end="url(#marker2914-1-3-1)"
|
||||
stroke="#005f87"
|
||||
stroke-width="0.75px"
|
||||
id="path25-7-0-2"
|
||||
style="fill:none;marker-end:url(#marker2914-1-3-1)" />
|
||||
<rect
|
||||
style="fill:#f5faff;fill-rule:evenodd;stroke:#91c8fa;stroke-width:0.1395;stroke-linecap:square;stroke-linejoin:bevel"
|
||||
x="269.4238"
|
||||
y="145.55312"
|
||||
width="24.596998"
|
||||
height="9.3690987"
|
||||
id="rect19-6-0-6-0" />
|
||||
<path
|
||||
d="m 281.7223,140.31331 v 5.2398"
|
||||
marker-end="url(#marker2914-1-6-4)"
|
||||
stroke="#005f87"
|
||||
stroke-width="0.75px"
|
||||
id="path25-7-1-6"
|
||||
style="fill:none;marker-end:url(#marker2914-1-6-4)" />
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 16 KiB |
@@ -1,9 +0,0 @@
|
||||
.. _api:
|
||||
|
||||
API Reference
|
||||
==============
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
||||
api/*
|
||||
@@ -1,370 +0,0 @@
|
||||
Building
|
||||
========
|
||||
|
||||
.. note::
|
||||
|
||||
If you just want to use the latest Release version of iaito, please note
|
||||
that we provide pre-compiled binaries for Windows, Linux and macOS on
|
||||
our `release page. <https://github.com/radareorg/cutter/releases/latest>`_
|
||||
|
||||
Getting the Source
|
||||
------------------
|
||||
|
||||
Make sure you've ``git`` installed in your system (`Installation guide <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_) and do the following:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
git clone --recurse-submodules https://github.com/radareorg/cutter
|
||||
|
||||
|
||||
This will clone the iaito source and it's dependencies(radare2, etc.)
|
||||
under **cutter** and you should see the following dir structure:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
cutter/-|
|
||||
|-docs/ # iaito Documentation
|
||||
|-radare2/ # radare2 submodule
|
||||
|-src/ # iaito Source Code
|
||||
|
||||
Following sections assume that **cutter** is your working dir. (if not, do ``cd cutter``)
|
||||
|
||||
Building on Linux
|
||||
-----------------
|
||||
|
||||
Requirements
|
||||
~~~~~~~~~~~~
|
||||
|
||||
On Linux, you will need:
|
||||
|
||||
* build-essential
|
||||
* cmake
|
||||
* meson
|
||||
* libzip-dev
|
||||
* libzlib-dev
|
||||
* qt5
|
||||
* qt5-svg
|
||||
* pkgconf
|
||||
* curl*
|
||||
* python-setuptools*
|
||||
* KSyntaxHighlighter**
|
||||
* graphviz**
|
||||
|
||||
`*` Recommended while building with ``make``/``Cmake``.
|
||||
|
||||
`**` Optional. If present, these add extra features to iaito. See `CMake Building Options`_.
|
||||
|
||||
On Debian-based Linux distributions, all of these essential packages can be installed with this single command:
|
||||
|
||||
::
|
||||
|
||||
sudo apt install build-essential cmake meson libzip-dev zlib1g-dev qt5-default libqt5svg5-dev qttools5-dev qttools5-dev-tools
|
||||
|
||||
.. note::
|
||||
For Ubuntu 18.04 and lower, ``meson`` should be installed with ``pip install --upgrade --user meson``.
|
||||
|
||||
On Arch-based Linux distributions:
|
||||
|
||||
::
|
||||
|
||||
sudo pacman -Syu --needed base-devel cmake meson qt5-base qt5-svg qt5-tools
|
||||
|
||||
Building Steps
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
The recommended way to build iaito on Linux is by using CMake. Simply invoke CMake to build iaito and its dependency radare2.
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mkdir build && cd build
|
||||
cmake -DIAITO_USE_BUNDLED_RADARE2=ON ../src
|
||||
cmake --build .
|
||||
|
||||
If your operating system has a newer version of CMake (> v3.12) you can use this cleaner solution:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
cmake -S src -B build -DIAITO_USE_BUNDLED_RADARE2=ON
|
||||
cmake --build build
|
||||
|
||||
.. note::
|
||||
If you want to use iaito with another version of radare2 you can omit ``-DIAITO_USE_BUNDLED_RADARE2=ON``. Note that using a version of radare2 which isn't the version iaito is using can cause issues and the compilation might fail.
|
||||
|
||||
.. note::
|
||||
|
||||
If you are interested in building iaito with support for Python plugins,
|
||||
Syntax Highlighting, Crash Reporting and more,
|
||||
please look at the full list of `CMake Building Options`_.
|
||||
|
||||
|
||||
After the build process is complete, you should have the ``iaito`` executable in the **build** dir.
|
||||
You can now execute iaito like this:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
./build/iaito
|
||||
|
||||
|
||||
Building on Windows
|
||||
-------------------
|
||||
|
||||
Requirements
|
||||
~~~~~~~~~~~~
|
||||
|
||||
iaito works on Windows 7 or newer.
|
||||
To compile iaito it is necessary to have the following installed:
|
||||
|
||||
* A version of Visual Studio (2015, 2017 and 2019 are supported)
|
||||
* CMake
|
||||
* Qt
|
||||
|
||||
Recommended Way
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
To build iaito on Windows machines using CMake,
|
||||
you will have to make sure that the executables are available
|
||||
in your ``%PATH%`` environment variable.
|
||||
|
||||
Note that the paths below may vary depending on your version of Qt and Visual Studio.
|
||||
|
||||
.. code:: batch
|
||||
|
||||
set CMAKE_PREFIX_PATH=c:\Qt\qt-5.6.2-msvc2013-x86\5.6\msvc2013\lib\cmake
|
||||
cd src
|
||||
mkdir build
|
||||
cd build
|
||||
cmake-gui ..
|
||||
|
||||
Click ``Configure`` and select your version of Visual Studio from the list,
|
||||
for example ``Visual Studio 14 2015``.
|
||||
After the configuration is done, click ``Generate`` and you can open
|
||||
``iaito.sln`` to compile the code as usual.
|
||||
|
||||
|
||||
Building with Meson
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
There is another way to compile iaito on Windows if the one above does
|
||||
not work or does not suit your needs.
|
||||
|
||||
Additional requirements:
|
||||
|
||||
- Ninja build system
|
||||
- Meson build system
|
||||
|
||||
Download and unpack
|
||||
`Ninja <https://github.com/ninja-build/ninja/releases>`__ to the iaito
|
||||
source root directory (ie. **cutter** - working dir).
|
||||
|
||||
Note that in the below steps, the paths may vary depending on your version of Qt and Visual Studio.
|
||||
|
||||
Environment settings (example for x64 version):
|
||||
|
||||
.. code:: batch
|
||||
|
||||
:: Export MSVC variables
|
||||
CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x64
|
||||
:: Add qmake to PATH
|
||||
SET "PATH=C:\Qt\5.10.1\msvc2015_64\bin;%PATH%"
|
||||
:: Add Python to PATH
|
||||
SET "PATH=C:\Program Files\Python36;%PATH%"
|
||||
|
||||
Install Meson:
|
||||
|
||||
.. code:: batch
|
||||
|
||||
python -m pip install meson
|
||||
|
||||
To compile iaito, run:
|
||||
|
||||
.. code:: batch
|
||||
|
||||
CALL prepare_r2.bat
|
||||
CALL build.bat
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Building with Qmake
|
||||
-------------------
|
||||
|
||||
Using QtCreator
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
One standard way is to simply load the project inside QtCreator.
|
||||
To do so, open QtCreator and on the welcome screen click on "Open Project",
|
||||
and finally select the ``cutter/src/iaito.pro`` file.
|
||||
QtCreator will then allow you to directly edit the source code and build the project.
|
||||
|
||||
.. note::
|
||||
|
||||
On **Windows**, for the ``.pro`` file to be compiled successfully, it is required
|
||||
to run ``prepare_r2.bat`` beforehand.
|
||||
|
||||
Compiling on Linux / macOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The easiest way, but not the one we recommend, is to simply run ``./build.sh`` from the root directory,
|
||||
and let the magic happen. The script will use ``qmake`` to build iaito.
|
||||
The ``build.sh`` script is meant to be deprecated and will be deleted in the future.
|
||||
|
||||
If you want to manually use qmake, follow these steps:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mkdir build; cd build
|
||||
qmake ../src/iaito.pro
|
||||
make
|
||||
cd ..
|
||||
|
||||
Additional Steps for macOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
On macOS you will also have to copy the launcher bash script:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mv iaito.app/Contents/MacOS/iaito iaito.app/Contents/MacOS/iaito.bin
|
||||
cp ../src/macos/iaito iaito.app/Contents/MacOS/iaito && chmod +x iaito.app/Contents/MacOS/iaito
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
CMake Building Options
|
||||
----------------------
|
||||
|
||||
Note that there are some major building options available:
|
||||
|
||||
* ``IAITO_USE_BUNDLED_RADARE2`` automatically compile Radare2 from submodule.
|
||||
* ``IAITO_ENABLE_PYTHON`` compile with Python support.
|
||||
* ``IAITO_ENABLE_PYTHON_BINDINGS`` automatically generate Python Bindings with Shiboken2, required for Python plugins!
|
||||
* ``IAITO_ENABLE_KSYNTAXHIGHLIGHTING`` use KSyntaxHighlighting for code highlighting.
|
||||
* ``IAITO_ENABLE_GRAPHVIZ`` enable Graphviz for graph layouts.
|
||||
* ``IAITO_EXTRA_PLUGIN_DIRS`` List of addition plugin locations. Useful when preparing package for Linux distros that have strict package layout rules.
|
||||
|
||||
iaito binary release options, not needed for most users and might not work easily outside CI environment:
|
||||
|
||||
* ``IAITO_ENABLE_CRASH_REPORTS`` is used to compile iaito with crash handling system enabled (Breakpad).
|
||||
* ``IAITO_ENABLE_DEPENDENCY_DOWNLOADS`` Enable downloading of dependencies. Setting to OFF doesn't affect any downloads done by r2 build. This option is used for preparing iaito binary release packges. Turned off by default.
|
||||
* ``IAITO_PACKAGE_DEPENDENCIES`` During install step include the third party dependencies. This option is used for preparing iaito binary release packges.
|
||||
|
||||
|
||||
These options can be enabled or disabled from the command line arguments passed to CMake.
|
||||
For example, to build iaito with support for Python plugins, you can run this command:
|
||||
|
||||
::
|
||||
|
||||
cmake -B build -DIAITO_ENABLE_PYTHON=ON -DIAITO_ENABLE_PYTHON_BINDINGS=ON
|
||||
|
||||
Or if one wants to explicitly disable an option:
|
||||
|
||||
::
|
||||
|
||||
cmake -B build -DIAITO_ENABLE_PYTHON=OFF
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Compiling iaito with Breakpad Support
|
||||
--------------------------------------
|
||||
|
||||
If you want to build iaito with crash handling system, you will want to first prepare Breakpad.
|
||||
For this, simply run one of the scripts (according to your OS) from root iaito directory:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
source scripts/prepare_breakpad_linux.sh # Linux
|
||||
source scripts/prepare_breakpad_macos.sh # MacOS
|
||||
scripts/prepare_breakpad.bat # Windows
|
||||
|
||||
Then if you are building on Linux you want to change ``PKG_CONFIG_PATH`` environment variable
|
||||
so it contains ``$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig``. For this simply run
|
||||
|
||||
.. code:: sh
|
||||
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
* **Cmake can't find Qt**
|
||||
|
||||
Cmake: qt development package not found
|
||||
|
||||
Depending on how Qt installed (Distribution packages or using the Qt
|
||||
installer application), CMake may not be able to find it by itself if it
|
||||
is not in a common place. If that is the case, double-check that the
|
||||
correct Qt version is installed. Locate its prefix (a directory
|
||||
containing bin/, lib/, include/, etc.) and specify it to CMake using
|
||||
``CMAKE_PREFIX_PATH`` in the above process, e.g.:
|
||||
|
||||
::
|
||||
|
||||
rm CMakeCache.txt # the cache may be polluted with unwanted libraries found before
|
||||
cmake -DCMAKE_PREFIX_PATH=/opt/Qt/5.9.1/gcc_64 ..
|
||||
|
||||
* **Radare2's libr_*.so cannot be found when running iaito**
|
||||
|
||||
./iaito: error while loading shared libraries: libr_lang.so: cannot open shared object file: No such file or directory
|
||||
|
||||
The exact r2 .so file that cannot be found may vary. On some systems, the linker by default uses RUNPATH instead of RPATH which is incompatible with the way r2 is currently compiled. It results in some of the r2 libraries not being found when running cutter. You can verify if this is the problem by running `ldd ./iaito`. If all the r2 libraries are missing you have a different problem.
|
||||
The workaround is to either add the `--disable-new-dtags` linker flag when compiling iaito or add the r2 installation path to LD_LIBRARY_PATH environment variable.
|
||||
|
||||
::
|
||||
|
||||
cmake -DCMAKE_EXE_LINKER_FLAGS="-Wl,--disable-new-dtags" ..
|
||||
|
||||
* **r_*.h: No such file or directory**
|
||||
|
||||
r_util/r_annotated_code.h: No such file or directory
|
||||
|
||||
If you face an error where some header file starting with ``r_`` is missing, you should check the **radare2** submodule and
|
||||
make sure it is in sync with upstream **iaito** repo. Simply run:
|
||||
|
||||
::
|
||||
|
||||
git submodule update --init --recursive
|
||||
|
||||
* **r_core development package not found**
|
||||
|
||||
If you installed radare2 and still encounter this error, it could be that your
|
||||
``PATH`` environment variable is set improperly (doesn’t contain
|
||||
``/usr/local/bin``). You can fix this by adding the radare2 installation dir to
|
||||
your ``PATH`` variable.
|
||||
|
||||
macOS specific solutions:
|
||||
|
||||
On macOS, that can also be, for example, due to ``Qt Creator.app``
|
||||
being copied over to ``/Applications``. To fix this, append
|
||||
``:/usr/local/bin`` to the ``PATH`` variable within the *Build
|
||||
Environment* section in Qt Creator. See the screenshot below should you
|
||||
encounter any problems.
|
||||
|
||||
You can also try:
|
||||
|
||||
- ``PKG_CONFIG_PATH=$HOME/bin/prefix/radare2/lib/pkgconfig qmake``
|
||||
- ``PKG_CONFIG_PATH=$HOME/cutter/radare2/pkgcfg qmake`` (for a newer
|
||||
version and if the radare2 submodule is being built and used)
|
||||
|
||||
.. image:: images/cutter_path_settings.png
|
||||
|
||||
You can also install radare2 into ``/usr/lib/pkgconfig/`` and then
|
||||
add a variable ``PKG_CONFIG_PATH`` with the value ``/usr/lib/pkgconfig/``.
|
||||
|
||||
* **macOS libjpeg error**
|
||||
|
||||
On macOS, Qt5 apps fail to build on QtCreator if you have the ``libjpeg``
|
||||
installed with brew. Run this command to work around the issue:
|
||||
|
||||
::
|
||||
|
||||
sudo mv /usr/local/lib/libjpeg.dylib /usr/local/lib/libjpeg.dylib.not-found
|
||||
* **LSOpenURLsWithRole() failed with error -10810**
|
||||
On macOS High Sierra iaito crashes due to the absence of ``gettext`` library. To fix this problem, simply install the missing package:
|
||||
|
||||
::
|
||||
|
||||
brew install gettext
|
||||
@@ -1,201 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file does only contain a selection of the most common options. For a
|
||||
# full list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Iaito'
|
||||
copyright = '2020, The Iaito Developers'
|
||||
author = 'The Iaito Developers'
|
||||
|
||||
# The short X.Y version
|
||||
version = '1.12'
|
||||
# The full version, including a2lpha/beta/rc tags
|
||||
release = '1.12.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'breathe',
|
||||
'recommonmark',
|
||||
'sphinx.ext.autosectionlabel'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = '.rst'
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'rainbow_dash'
|
||||
|
||||
|
||||
autosectionlabel_prefix_document = True
|
||||
autosectionlabel_maxdepth = 2
|
||||
|
||||
# -- Options for Breathe -----------------------------------------------------
|
||||
|
||||
breathe_projects = { 'cutter': '../doxygen-out/xml' }
|
||||
breathe_default_project = 'cutter'
|
||||
breathe_default_members = ('members', 'undoc-members')
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'cutter_theme'
|
||||
html_theme_path = ['..']
|
||||
html_logo = '../../src/img/cutter.ico'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ['static']
|
||||
|
||||
html_js_files = [
|
||||
'cutter.js',
|
||||
]
|
||||
|
||||
html_css_files = [
|
||||
'cutter.css',
|
||||
'admonitions.css'
|
||||
]
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# The default sidebars (for documents that don't match any pattern) are
|
||||
# defined by theme itself. Builtin themes are using these templates by
|
||||
# Default: html_sidebars = {
|
||||
# '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
|
||||
# 'using/windows': ['windowssidebar.html', 'searchbox.html'],
|
||||
# }
|
||||
html_sidebars = {
|
||||
'**': ['globaltoc.html', 'searchbox.html'],
|
||||
}
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'IaitoDoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'Iaito.tex', 'Iaito Documentation',
|
||||
'The Iaito Developers', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'cutter', 'Iaito Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output ----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'Iaito', 'Iaito Documentation',
|
||||
author, 'Iaito', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Epub output -------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = project
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#
|
||||
# epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#
|
||||
# epub_uid = ''
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
@@ -1,29 +0,0 @@
|
||||
Contributing to Iaito
|
||||
=======================
|
||||
|
||||
So you like Iaito and want to get involved? Great! This part of the documentation will help and guide you through everything you need to know when contributing to Iaito. Welcome, we're delighted to see you!
|
||||
|
||||
.. tip::
|
||||
**Need help?** Our community strives to be friendly, open, and accessible for new contributors. If you have any difficulties getting involved or finding answers to you questions, please `come and ask your questions on our Telegram or IRC groups <https://cutter.re/#community>`_.
|
||||
|
||||
We know that set up to work on Iaito and finding issues that are a good fit for your skills can be a challenge. We're always looking for ways to improve this process: making Iaito more open, accessible, and easier to participate with. If you're having any trouble following this documentation or hit a barrier you can't get around, please contact us.
|
||||
|
||||
.. rubric:: How do you want to help?
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<a class="btn btn-outline-primary btn-lg m-2" role="button" href="contributing/code/getting-started.html">Code</a>
|
||||
<a class="btn btn-outline-warning btn-lg m-2" role="button" href="contributing/docs/getting-started.html">Documentation</a>
|
||||
<a class="btn btn-outline-success btn-lg m-2" role="button" href="contributing/plugins/getting-started.html">Plugins</a>
|
||||
<a class="btn btn-outline-info btn-lg m-2" role="button" href="contributing/translations/getting-started.html">Translations</a>
|
||||
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:titlesonly:
|
||||
|
||||
contributing/code
|
||||
contributing/docs
|
||||
contributing/translations/getting-started
|
||||
contributing/plugins/getting-started
|
||||
@@ -1,14 +0,0 @@
|
||||
Developer Documentation
|
||||
=======================
|
||||
|
||||
.. note::
|
||||
New to Iaito development? Check out our :doc:`tutorial for new developers <code/getting-started>`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:glob:
|
||||
|
||||
Getting Started <code/getting-started>
|
||||
code/development-guidelines
|
||||
code/ide-setup
|
||||
code/*
|
||||
@@ -1,32 +0,0 @@
|
||||
Crash Handling System
|
||||
=====================
|
||||
|
||||
Iaito uses `Breakpad <https://github.com/google/breakpad>`__ as a backend
|
||||
for crash handling.
|
||||
|
||||
Crash Handling System is disabled by default to not interfere with developers while debugging.
|
||||
To enable this system, set the ``IAITO_ENABLE_CRASH_REPORTS`` build option.
|
||||
|
||||
Solution Description
|
||||
--------------------
|
||||
|
||||
There are only 2 source files:
|
||||
|
||||
* ``CrashHandler.h``
|
||||
* ``CrashHandler.cpp``
|
||||
|
||||
And the API is very simple: One function, ``initCrashHandler()``, enables the Crash Handling System if
|
||||
``IAITO_ENABLE_CRASH_REPORTS`` is true, otherwise it does nothing.
|
||||
|
||||
As soon as a signal is raised, ``crashHandler(int signum)`` is called with the signal's code as an argument.
|
||||
This function first writes a crash dump to the operating system's temporary directory to catch core and
|
||||
memory state as it was at the moment of the crash.
|
||||
|
||||
Then the crash dialog is shown:
|
||||
|
||||
.. image :: /images/crash-dialog.png
|
||||
|
||||
If the user chooses to create a crash dump, the prepared dump is moved to the directory specified by the user.
|
||||
And then the success dialog is shown:
|
||||
|
||||
.. image :: /images/success-dump-dialog.png
|
||||
@@ -1,266 +0,0 @@
|
||||
|
||||
Iaito Development Guidelines
|
||||
===============================
|
||||
|
||||
.. note::
|
||||
New to Iaito development? Check out our :doc:`tutorial for new developers <getting-started>`.
|
||||
|
||||
|
||||
Common Usage
|
||||
--------------
|
||||
|
||||
IaitoCore Class
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
This is the main class where every link with r2 is made. It is *unique*
|
||||
across the whole process. To access it, simply call ``Core()``.
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
Core()->getOffset();
|
||||
|
||||
Calling a radare2 Command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
There are multiple ways to call a radare2 command:
|
||||
|
||||
- ``IaitoCore::cmdj(<command>)`` - To be used with json commands like ``cmdj("agj")`` or ``cmdj("aflj")``.
|
||||
This is the command we used to fetch structured data from radare2.
|
||||
|
||||
- ``IaitoCore::cmdRaw(<command>)`` - Executes a single radare2 command
|
||||
without going through radare2 shell functionality like output redirects, grep, and multiple command parsing.
|
||||
|
||||
The command then returns its output. This should be used when a command doesn't have output or the output should be handled as-is. If possible, using the JSON variation with ``cmdj`` is always preferred.
|
||||
|
||||
- ``IaitoCore::cmdRawAt(<command>, <address>)`` - Executes a single radare2 command in a given address and returns the output. This helps avoiding weird strings concatenation like ``cmd("ph " + hash + " @ " + QString::num(address))``.
|
||||
|
||||
- ``IaitoCore::cmd()`` - *(Discouraged)* Only use it when ``cmdj`` or ``cmdRaw`` cannot be used. This is used for complex commands using concatenation of several commands (``px 5; pd 7; afl;``), for grepping (``pd 5~call``). for commands inside commands (``?e `afn.```) and so on.
|
||||
This is also used when the output is complex and is not parsed correctly in ``cmdRaw``.
|
||||
Make sure to carefully sanitize user-controlled variables that are passed to the command, to avoid unexpected command injections.
|
||||
|
||||
Generally, if one needs to retrieve information from a radare2 command, it
|
||||
is preferred to use the JSON API.
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
QJsonArray array = Core()->cmdj("pdj 1 @ main").array();
|
||||
|
||||
Seek the Current File
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To modify radare2 seek use ``IaitoCore::seek(const RVA offset)``. This
|
||||
is important because it will emit a
|
||||
``IaitoCore::seekChanged(RVA offset)`` signal. Never ever call
|
||||
``cmd("s offset")``;
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
Core()->seek(0x00C0FFEE);
|
||||
|
||||
.. note::
|
||||
|
||||
Iaito also supports a silent seek which doesn't trigger the ``seekChanged`` event and doesn't add new entries to the seek history.
|
||||
|
||||
|
||||
Creating a Widget
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Make sure to connect the ``IaitoCore::seekChanged(RVA offset)`` signal
|
||||
so your widget refreshes its output when radare2 seek is modified
|
||||
(switching to another function, etc.).
|
||||
|
||||
Coding Style
|
||||
------------
|
||||
|
||||
In general, we follow `the official Qt guidelines <https://wiki.qt.io/Qt_Coding_Style>`__ to
|
||||
format the code. If in doubt, you can use `AStyle
|
||||
2.06 <https://sourceforge.net/projects/astyle/files/astyle/astyle%202.06/>`__
|
||||
to format the code. The command line for formatting the code according
|
||||
to the style is:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
astyle --project=src/Iaito.astylerc src/filename.cpp
|
||||
|
||||
In contrast to the official guidelines of Qt, in Iaito we always use curly braces in conditional statements, even if the body of a conditional statement contains only one line.
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
// Wrong
|
||||
if (address.isEmpty())
|
||||
return false;
|
||||
|
||||
// Correct
|
||||
if (address.isEmpty()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Wrong
|
||||
for (int i = 0; i < 10; ++i)
|
||||
qDebug("%i", i);
|
||||
|
||||
// Correct
|
||||
for (int i = 0; i < 10; ++i) {
|
||||
qDebug("%i", i);
|
||||
}
|
||||
|
||||
|
||||
Includes
|
||||
~~~~~~~~
|
||||
|
||||
Strive to include only **required** definitions inside header files.
|
||||
This will avoid triggering additional unnecessary compilations.
|
||||
|
||||
If you only need to know that a class exists but don't need the prototype,
|
||||
you can declare the class like this:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
class MyClassThatExists;
|
||||
|
||||
/** ... **/
|
||||
|
||||
private:
|
||||
MyClassThatExists *classInstance;
|
||||
|
||||
And then include the class header inside your .cpp so you can use that class.
|
||||
|
||||
If you need something in the source file (.cpp) that is not a class member,
|
||||
then add the include in the source file.
|
||||
|
||||
The includes must be ordered from local to global. That is, first include
|
||||
any local header file (with double quotes like `#include "common/Helpers.h"`.
|
||||
Then, after an empty newline, include Qt definitions like
|
||||
`#include <QShortcut>`.
|
||||
Finally, include the standard C++ headers you need.
|
||||
|
||||
Includes must be sorted by alphabetical order.
|
||||
|
||||
Docstrings
|
||||
~~~~~~~~~~
|
||||
|
||||
Our API reference is generated using Doxygen, so when it comes to
|
||||
function documentation, please use the following format:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
/**
|
||||
* @brief Add a new param to the accumulator
|
||||
*/
|
||||
virtual void accumulate(RefreshDeferrerParams params) =0;
|
||||
|
||||
Loops
|
||||
~~~~~
|
||||
|
||||
We use the C++11 foreach loop style, which means any “foreach” loop should
|
||||
look like:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
for (QJsonValue value : importsArray) {
|
||||
doSomething(value);
|
||||
}
|
||||
|
||||
nullptr
|
||||
~~~~~~~
|
||||
|
||||
Please do not use ``0`` nor ``Q_NULLPTR``, only use ``nullptr``.
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
QObject *object = nullptr;
|
||||
|
||||
Connecting Qt Signals
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Use one of the following methods for connecting signals to slots:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
// typically you will make connection in the constructor to a member of current class
|
||||
connect(this->ui->button1, &QPushButton::clicked,
|
||||
this, &MyObject::buttonClicked); // Good
|
||||
|
||||
// you can also connect directly other object slots
|
||||
connect(checkbox, &QCheckBox::toggled, widget, &QWidget::setEnabled); // Good
|
||||
|
||||
// use lambda for passing extra arguments
|
||||
connect(button1, &QPushButton::clicked, this, [this](){ foo(getBar()); }); // Good
|
||||
|
||||
This syntax performs compile-time type checks and allows the use of lambda
|
||||
functions. Other approaches for connecting signals can silently break at runtime.
|
||||
|
||||
Don't use the older macro based syntax or automatic name based connections.
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
// SIGNAL and SLOT macros
|
||||
connect(sender, SIGNAL(clicked), this, SLOT(buttonClicked)); // BAD
|
||||
|
||||
// automatic name based connection
|
||||
slot:
|
||||
void on_actionNew_triggered(); // BAD
|
||||
|
||||
// 3 argument connect without receiver object
|
||||
connect(sender, &SomeObject::signal, [this](){ this->foo(getBar()); }); // BAD
|
||||
|
||||
|
||||
General Coding Advices
|
||||
----------------------
|
||||
|
||||
Functions Documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can find the class documentation in the API Reference menu item.
|
||||
|
||||
Updating the Git Submodules
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Git submodules play a major part in Iaito. This, because Iaito is powered
|
||||
by radare2, its parent project, and it tries to stay up-to-date with its
|
||||
recent version, which allows us to implement new features, and enjoy bug
|
||||
fixes and performance improvements on radare2. Often, we need to update
|
||||
the radare2 submodule or the others, to push their most recent
|
||||
version to Iaito.
|
||||
|
||||
You can view the list of all the submodules from the cutter root folder with:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
git config --file .gitmodules --get-regexp path | awk '{ print $2 }'
|
||||
|
||||
To update all the submodules at once, run these commands from the
|
||||
cutter root folder:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
git submodule foreach git pull origin master
|
||||
git add submodule_name_1 submodule_name_2
|
||||
git commit -m "Update submodules"
|
||||
|
||||
More likely, you'll only need to update the radare2 submodule.
|
||||
In order to update one submodule individually, use the following code:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
cd radare2
|
||||
git checkout master && git pull
|
||||
cd ..
|
||||
git add radare2
|
||||
git commit -m "Update radare2 submodule"
|
||||
|
||||
|
||||
Useful Resources (Qt Development)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* `Signals & Slots <https://doc.qt.io/qt-5/signalsandslots.html>`__
|
||||
* `Model/View Programming <https://doc.qt.io/qt-5/model-view-programming.html>`__ - read this if you are going to work with a list or table-like widgets
|
||||
* `QAction <https://doc.qt.io/qt-5/qaction.html#details>`__
|
||||
@@ -1,96 +0,0 @@
|
||||
Contributing code to Iaito
|
||||
============================
|
||||
|
||||
Thank you so much for your interest in contributing to Iaito! Contributors like you are a treasured resource for Iaito and their contributions have made the project what it is. And so, we appreciate everyone who gives the community the gift of their time <3.
|
||||
|
||||
The following section in our documentation is *not* intended to be comprehensive but rather a quick guide to walk you through the basic flow of contributing to Iaito. For more thorough documentation, follow the links on this page and read our Development Guidelines.
|
||||
|
||||
Clone and compile Iaito
|
||||
-------------------------
|
||||
The first step before starting to add code to Iaito is to build it on your environment. Whether it is Linux, Windows, or macOS, we have you covered and detailed the instructions to compile Iaito on our :doc:`/building`. Once you are done and Iaito is built successfully, test that it works correctly and continue to the next steps.
|
||||
|
||||
.. tip::
|
||||
If you are facing issues with building Iaito on your environment, make sure you didn't miss anything in the documentation. Specifically, check the :ref:`Building:Troubleshooting` section.
|
||||
|
||||
.. tip::
|
||||
If you need help configuring your development environment, make sure to read our :doc:`instructions, recommendations and tips <ide-setup>` for setting up a Iaito development environment for popular IDEs.
|
||||
|
||||
|
||||
|
||||
Find something to work on
|
||||
--------------------------
|
||||
Some will reach this page with a clear idea of what issue they want to fix or what feature they wish to implement. But some would simply want to help Iaito getting better while doing open-source, without having a specific thing in mind. If you already have something in mind - great! Move forward to the next section. If you don't have anything specific, stick with us a little bit more.
|
||||
|
||||
The issues and the feature-requests of Iaito are listed and tracked on our `Github Issues <https://github.com/radareorg/cutter/issues>`_ page. Don't get scared by the number of issues open, we will learn how to filter them to find those which fit you best.
|
||||
|
||||
.. tip::
|
||||
**Fix your pet peeve!** Anything specific that annoys you about Iaito? Fantastic! This can be a great place to start.
|
||||
|
||||
|
||||
Organizing issues
|
||||
*******************
|
||||
In order to organize the hundreds of Issues opened on Iaito, we use several features of Github for project management. Get yourself familiar with the following features, it will help you filter the issues.
|
||||
|
||||
Labels
|
||||
^^^^^^^^
|
||||
Tagging issues and pull requests with labels allows us to quickly search for them later. We use labels to describe the type of the issue, the feature it belongs to, the difficulty, and even its priority. We recommend you to start from issues labeled as `good-first-issue <https://github.com/radareorg/cutter/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_. These issues were tagged by us as suitable for new contributors.
|
||||
|
||||
Projects
|
||||
^^^^^^^^^^
|
||||
We use `project boards <https://github.com/radareorg/cutter/projects>`_ to gather together tasks and issues for specific features or problems. For example, we have dedicated project boards for Debugger, Hexdump widget, Decompiler widget, and High DPI support. If you are interested to take part in developing a major feature, or you want to get a broader look at a progress of a specific part in Iaito, this can be a good place to visit.
|
||||
|
||||
Milestones
|
||||
^^^^^^^^^^^^
|
||||
|
||||
When starting working on a new release, we gather together the bug and feature-requests that we consider of high-priority into a `Milestone <https://github.com/radareorg/cutter/milestones>`_. If you want to work on a feature or fix a bug that is needed and prioritized for the next release, then check out the open Milestone,.
|
||||
|
||||
|
||||
Assigning Issues
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Before choosing an issue to work on, make sure it is not assigned to anyone. If it is, you can comment and ask if this person is intended to work on the issue. Some assigned issues are abandoned by their assignee and can be picked up by other contributors.
|
||||
|
||||
|
||||
|
||||
Get familiar with the current situation
|
||||
----------------------------------------
|
||||
|
||||
Run Iaito and get familiar with how the functionality you want to modify works currently. For example, if it is a dialog, make sure you understand its role and how our users are using it. If it is a bug, try to repeat it using the instructions from the bug report.
|
||||
|
||||
.. tip::
|
||||
If you are inexperienced with binary analysis tasks, you can always ask other developers in the team about the feature and how it should be used. The team and the community will be happy to help and instruct you with everything you need to know.
|
||||
|
||||
Find the source files implementing the feature you want to work on. By doing this, practice searching code in your editor, this is an important skill. We suggest searching for files with the name of the feature. For example, if you are interested in improving the "Sections" widget, you can find the source code of this feature in `SectionsWidget.cpp` and `SectionsWidget.h`. Alternatively, you can try and look for specific unique strings that exist in the dialog, widget, or feature you want to improve. Usually, when searching the entire code base for these strings, you'll land on a file related to this feature, whether it is a ``.cpp`` file or a ``.ui`` file. From there it will be easy to navigate your way to the right place.
|
||||
|
||||
|
||||
Work on your feature or bug-fix
|
||||
-------------------------------
|
||||
|
||||
If you are experienced with such tasks, go ahead - we leave this in your hands. Otherwise, we recommend you come up with a plan for things that need to be done to solve this bug or implement this feature. Discuss your plan in the relevant issue on GitHub.
|
||||
|
||||
.. important::
|
||||
Before starting coding, make sure to get yourself familiar with our comprehensive documentation for our `coding style, conventions, and guidelines <development-guidelines.html>`_.
|
||||
|
||||
|
||||
If you don't know how to implement something, check if any of the existing code implements similar behavior in the same widget or similar widgets. If you do copy an existing code consider why it did things the way it did, the same factors might not apply in your case or the old code was poorly written from the first place.
|
||||
|
||||
Open a Pull request
|
||||
-------------------
|
||||
|
||||
When you are done, and the additions and modifications to the code are in place, commit your changes, and get your code reviewed by opening a new Pull Request. Please remember to follow the Pull Request template.
|
||||
|
||||
In the Pull Request template you will be required to add a "Test plan". For example, if you performed GUI changes, demonstrate it by posting a screenshot. Make a list of steps to be taken by the reviewers to verify that the changes are working as expected. This is also a good point to consider any potential edge-cases or different kinds of inputs if you didn't already do it while writing the code. Perform the steps you described when making the PR even if they seem trivial and you did them during development, it helps to catch any mistakes done during the final cleanup and making sure you didn't forget anything.
|
||||
|
||||
|
||||
Repeat
|
||||
-------
|
||||
|
||||
**Thank you!** You've made your very first contribution, and Iaito is better for it. But don't stop now. Go back to the first steps, as there is plenty more to do. A mentor or other developers might suggest a new issue for you to work on.
|
||||
|
||||
|
||||
More Information
|
||||
-----------------
|
||||
|
||||
.. important::
|
||||
We're always in the process of improving the information on this page for newcomers to the Iaito. Please help us by suggesting improvements and tell us about the information that this page lacks.
|
||||
|
||||
@@ -1,200 +0,0 @@
|
||||
Development environment setup
|
||||
=============================
|
||||
|
||||
This page contains recommendations and tips on how to better setup different IDEs for Iaito development.
|
||||
|
||||
|
||||
General advice
|
||||
--------------
|
||||
Everyone has their own preferences for their favorite IDE or code editor.
|
||||
There are no strict requirements for using a specific one for Iaito development.
|
||||
Any IDE with good CMake integration should work well.
|
||||
|
||||
For most development builds, unless you are working on packaging issues, it is recommended to use ``IAITO_USE_BUNDLED_RADARE2=ON`` Cmake option. It is the easiest way to ensure that a compatible r2 version is used, and helps you deal with different versions of radare2 when working with multiple Iaito branches. On Linux, in case you have multiple r2 versions without ``IAITO_USE_BUNDLED_RADARE2``, the ``PKG_CONFIG_PATH`` environment variable can be used to select the desired radare2 installation.
|
||||
|
||||
While `Qt Creator`_ has a builtin visual form and widget editor, not having it in other IDEs is not a major problem. It is also available as a standalone tool called Qt Designer and you can configure the file associations so that ``.ui`` files are opened using it. Depending on the ``.ui`` file and changes you want to make, it is sometimes easier to perform them by editing the ``.ui`` file as a text file. Essentially, ``.ui`` files are XML files. Most code editors should have some support for XML highlighting and possibly block folding.
|
||||
|
||||
The following instructions and recommendations assume that you have already download Iaito source and obtained required dependencies as described in :doc:`/building`.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
On a rolling-release distribution or a somewhat recent version of traditional distributions like Ubuntu 18.04, it should be possible to get all the dependencies from the official repository. There might be some problems with PySide2 and Shiboken2 but it can be easily disabled and isn't necessary for most work on Iaito. Don't try to install PySide using pip.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Assuming you have a sufficiently powerful computer, a nice way of getting and configuring Qt for Iaito is to use `vcpkg <https://github.com/Microsoft/vcpkg>`_.
|
||||
For a quick test, the exact versions of libraries used by Iaito release packages can be obtained from `cutter-deps <https://github.com/radareorg/cutter-deps/releases>`_ but they don't contain debug
|
||||
versions of libraries so they are not suitable for more serious Iaito development on Windows.
|
||||
|
||||
Qt Creator
|
||||
----------
|
||||
QT Creator is an open-source IDE made by the same developers as Qt.
|
||||
|
||||
Even though Iaito has qmake project cutter.pro it is recommended to use the CMake project in QTCreator.
|
||||
QTCreator support for CMake is as good as qmake one but not all Iaito project configuration options are available in qmake project and in future Iaito qmake project might be removed.
|
||||
|
||||
Pros and Cons
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
- builtin help for Qt API
|
||||
- builtin .ui file editor (Qt Designer - visual form editor)
|
||||
- builtin helper for displaying Qt types in the debugger
|
||||
- Viewing source files that are not directly part of the project (R2 source code) is somewhat inconvenient.
|
||||
- The simplest way of installing on non-Linux operating systems require login with Qt account
|
||||
|
||||
Project setup
|
||||
~~~~~~~~~~~~~
|
||||
The following instructions were made based on version 4.12.4 of Qt Creator. The steps might slightly differ between the versions.
|
||||
|
||||
- Go to :menuselection:`File --> Open File or Project..` and select :file:`cutter/src/CMakeList.txt`
|
||||
- Select kit and press :guilabel:`Configure Project`
|
||||
- Configuration step might fail due to r2 not being found, that's normal
|
||||
- Click :guilabel:`Projects` button with wrench icon on the left side of the screen
|
||||
- Click :menuselection:`Add --> Boolean` in the CMake section
|
||||
- Enter ``IAITO_USE_BUNDLED_RADARE2`` as a key name and change the value to ON. In earlier Qt Creator versions it is necessary to do this during the initial kit selection and configuration step.
|
||||
- Click :guilabel:`Apply Configuration Changes`:. The configuration should succeed now. In case of errors inspect the output log.
|
||||
|
||||
Either in :menuselection:`Projects --> Code Style --> C++` or :menuselection:`Tools --> Options --> C++ --> Code Style` select :guilabel:`Qt [built-in]`. It should be selected by default unless you have used Qt Creator for other projects. Iaito Coding style is almost identical to Qt one. This will help with using correct indentation type and basic formatting without running code formatter.
|
||||
|
||||
To configure AStyle for formatting a file go to :menuselection:`Tools --> Options --> Beautifier --> Artistic Style`. If necessary, specify the path to astyle executable. The :guilabel:`Use file \*.astylerc defined in project files` option doesn't seem to be working reliably so it is necessary to use :guilabel:`Use specific config file` option. Iaito astyle configuration is stored in :file:`cutter/src/Iaito.astylerc`.
|
||||
|
||||
Changing CMake configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Click on the "Projects" button on the left side of the screen and then select "Build". All the project CMake options are listed and can be edited there in a graphical editor.
|
||||
|
||||
Editing Qt .ui files
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
Double-clicking a ``.ui`` file in a file list opens it inside a visual editor. If you want to make changes that are easier to do by editing ``.ui`` file as text - right-click the file and select :menuselection:`Open With --> Plain Text Editor`. Switching from visual form editor back to code editor mode will open the ``.ui`` file in read-only mode with the following warning "This file can only be edited in Design mode". To edit use the same steps as described before.
|
||||
|
||||
VS Code
|
||||
-------
|
||||
`VS Code <https://github.com/Microsoft/vscode>`_ is an open-source code editor made by Microsoft.
|
||||
|
||||
Pros and Cons
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
- A large number of plugins
|
||||
- A good fallback mechanism for files that are not directly part of a project.
|
||||
|
||||
Recommended plugins
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
- `C/C++ <https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools>`_ - The official C++ support plugin made by Microsoft
|
||||
- `CMake Tools <https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools>`_ - Provides CMake project integration. Originally developed by vector-of-bool and currently maintained by Microsoft.
|
||||
- `CMake <https://marketplace.visualstudio.com/items?itemName=twxs.cmake>`_ - CMake language support when editing CMake files. Does not replace the previous CMake plugin. They provide non-overlapping functionality and should be used together.
|
||||
|
||||
Project setup
|
||||
~~~~~~~~~~~~~
|
||||
- :menuselection:`File --> Open Folder...` and select the folder in which you cloned Iaito
|
||||
- Install the recommended plugins.
|
||||
- Once the `CMake Tools` plugin is installed, in the corner you will see a popup asking you "Would you like to configure project 'cutter'? Source: CMake Tools (Extension)". Click Yes.
|
||||
- In the kit selection popup, choose :guilabel:`[Unspecified]` unless you have more specific needs.
|
||||
- If you initially dismissed the configuration window or didn't have the plugins installed yet - open command-palette using :kbd:`Ctrl-Shift-P` and select :guilabel:`Cmake: Configure`
|
||||
|
||||
Changing CMake configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
After the first configuration :kbd:`Ctrl-Shift-P`/:guilabel:`CMake: Edit CMake Cache` opens a text editor with all CMake options. Iaito specific ones mostly start with "CUTTER".
|
||||
|
||||
.. note::
|
||||
``IAITO_USE_BUNDLED_RADARE2`` option is also defined in ``.vscode/settings.json`` file and it will be overridden from there. It is set to ``ON`` by default as it is recommended during development.
|
||||
|
||||
.. _vscode-debug-setup:
|
||||
|
||||
Building, Running, Debugging
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Build and running commands are available in the status bar at the bottom and in the Command Palette menu (:kbd:`Ctrl-Shift-P`) named ``CMake: Build F7``, ``CMake: Run Without Debugging Shift+F5``, and ``CMake Debug Ctrl + F5``.
|
||||
Shortcuts can be viewed in the :kbd:`Ctrl-Shift-P` menu. They don't match default VS Code ones since those depend on :file:`tasks.json``.
|
||||
|
||||
Running and debugging launches the executable without any arguments. Command-line arguments can be passed to the debug
|
||||
executable by creating a ``.vscode/launch.json`` configuration. Read the `documentation <https://code.visualstudio.com/docs/cpp/launch-json-reference>`_ for more information. Instead of creating :file:`launch.json` manually it can be created from template: :kbd:`Ctrl-Shift-P`/:menuselection:`Debug: Select and Start Debugging --> Add configuration.. --> C,C++: (gdb) Launch`.
|
||||
|
||||
To setup gdb pretty printers for Qt types on Linux, download the scripts from `Kdevelop <https://github.com/KDE/kdevelop/tree/master/plugins/gdb/printers>`_. In the :file:`~/.gdbinit` file add the following code:
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
python
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, '/path/to/folder/with/pretty_printer_scripts')
|
||||
from qt import register_qt_printers
|
||||
register_qt_printers (None)
|
||||
|
||||
end
|
||||
set print pretty 1
|
||||
|
||||
|
||||
CLion
|
||||
-----
|
||||
`CLion <https://www.jetbrains.com/clion/>`_ is a C and C++ IDE from the popular software development tool maker - JetBrains.
|
||||
|
||||
|
||||
Pros and Cons
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
- Medium amount of plugins, many first-party plugins made by JetBrains for their IntelliJ based IDE family
|
||||
- There is no free version
|
||||
- Takes some time to analyze the files after opening a project. Switching between .cpp and corresponding .h file may for the first time may take a few seconds.
|
||||
|
||||
Project setup
|
||||
~~~~~~~~~~~~~
|
||||
- Go to :menuselection:`File --> Open` and select the folder in which you cloned Iaito
|
||||
- Go to :menuselection:`File --> Settings --> Build, Execution, Deployment --> CMake`. In the :guilabel:`CMake Options` field enter ``-DIAITO_USE_BUNDLED_RADARE2=ON``
|
||||
- Open :file:`cutter/src/CMakeLists.txt` using the project file list on the left side of the screen
|
||||
- A yellow bar with a message :guilabel:`CMake project is not loaded` should appear, click :guilabel:`Load CMake project`
|
||||
|
||||
Changing CMake configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Go to :menuselection:`File --> Settings --> Build,Execution,Deployment --> CMake`. CMake options are specified the same way as on command-line ``-DOPTION_NAME=VALUE``.
|
||||
|
||||
Building, Running, Debugging
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Follow the `Clion documentation <https://www.jetbrains.com/help/clion/qt-tutorial.html#debug-renderers>`_ for how to configure Qt type debugger renderers. If you are using the MSVC toolchain
|
||||
it can use :file:`qt5.natvis`. In rest of the cases you can use ``.gdbinit`` or ``..ldbinit`` based approach similar to one described for :ref:`VSCode setup<vscode-debug-setup>`
|
||||
|
||||
Editing Qt .ui files
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
Default CLion behavior for opening .ui files is `somewhat buggy <https://youtrack.jetbrains.com/issue/CPP-17197>`_. Double-clicking the file does nothing, but it can be opened by dragging it to the text editor side.
|
||||
This can be somewhat improved by changing `file association <https://www.jetbrains.com/help/clion/creating-and-registering-file-types.html>`_. Open :menuselection:`File --> Settings --> Editor --> File Types` and change type association of \*.ui files from :guilabel:`Qt UI Designer Form` to either "XML" or :guilabel:`Files Opened in Associated Applications`.
|
||||
The first one will open it within CLion as an XML file and the second will use the operating system configuration.
|
||||
|
||||
Visual Studio
|
||||
-------------
|
||||
Visual Studio Community edition is available for free and can be used for contributing to open source projects.
|
||||
|
||||
It is recommended to use the latest Visual Studio version 2019 because it has the best CMake integration.
|
||||
Older VS versions can be used but CMake integration isn't as good. With those, it might be better to generate Visual Studio
|
||||
project from CMake project using the command-line or :command:`cmake-gui` and opening the generated Visual Studio project instead of opening the
|
||||
CMake project directly.
|
||||
|
||||
Visual Studio supports many different languages and use-cases. Full installation takes a lot of space. To keep the size minimal during installation
|
||||
select only component called "Desktop development with C++". Don't worry too much about missing something.
|
||||
Additional components can be later added or removed through the VS installer which also serves as an updater and package manager for Visual Studio components.
|
||||
|
||||
Pros and Cons
|
||||
~~~~~~~~~~~~~
|
||||
- good debugger
|
||||
- medium amount of plugins
|
||||
- completely closed source
|
||||
- Windows only
|
||||
|
||||
Project setup
|
||||
~~~~~~~~~~~~~
|
||||
- Open folder in which you cloned Iaito source using Visual Studio
|
||||
- Open CMake settings configurator using either :menuselection:`Project --> CMake Settings` or by clicking :guilabel:`Open the CMake Settings Editor` in the overview page.
|
||||
- Check ``IAITO_USE_BUNDLED_RADARE2`` option
|
||||
- If you are using vcpkg, Visual Studio should detect it automatically. The list of CMake options in the configurator should have some referring to vcpkg. If they are not there, specify the path to vcpkg toolchain file in the :guilabel:`CMake toolchain file` field.
|
||||
- If you are not using vcpkg, configure the path to Qt as mentioned in :ref:`windows CMake instructions<building:Building on Windows>`. You can specify the CMake flag in :guilabel:`CMake command arguments:` field.
|
||||
- To Ensure that VS debugger can display Qt types in a readable way, it is recommended to install `Qt Visual Studio Tools <https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools2019>`_ plugin. It will create a :file:`Documents/Visual Studio 2019/Visualizers/qt5.natvis` file. Once :file:`qt5.natvis` has been created you can uninstall the plugin.
|
||||
|
||||
Changing CMake configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Open :menuselection:`Project --> CMake Settings`. CMake options can be modified either in graphical table editor, as a command-line flag or by switching to the JSON view.
|
||||
|
||||
Editing Qt .ui files and Qt integration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
By default Visual Studio will open ``.ui`` files as XML text documents. You can configure to open it using Qt Designer by right-clicking and selecting :guilabel:`Open With...`.
|
||||
|
||||
There is a Qt plugin for Visual Studio from Qt. It isn't very useful for Iaito development since it is aimed more at helping with Qt integration into Visual Studio projects.
|
||||
It doesn't do much for CMake based projects. The biggest benefit is that it automatically installs :file:`qt5.natvis` file for more readable displaying of Qt types in the debugger.
|
||||
@@ -1,59 +0,0 @@
|
||||
Release Procedure
|
||||
=================
|
||||
|
||||
1. Update translations submodule `https://github.com/radareorg/iaito-translations`_
|
||||
1. The latest archive from Crowdin should already be in the repository, if not make sure to merge any automated Pull Request from Crowdin (e.g. https://github.com/radareorg/iaito-translations/pull/9)
|
||||
2. Update submodule in iaito
|
||||
2. If there is a desire to keep working in the master branch, create branch for the release and do all the following work there.
|
||||
3. Lock r2ghidra and r2dec versions downloaded by packaging scripts. Specify a tag or commit hash.
|
||||
4. Update version
|
||||
#. appveyor.yml
|
||||
#. docs/sourc/conf.py
|
||||
#. docs/source/index.rst
|
||||
#. Iaito.pro
|
||||
#. Iaito.appdata.xml
|
||||
#. To be safe, search the code base for the previous version number.
|
||||
5. Create a tag for the release candidate. For example, for the `v1.11.0` release you'd do something like this:
|
||||
#. ``git tag v1.11.0-rc1``
|
||||
#. ``git tag push origin v1.11.0-rc1``
|
||||
6. Create a GitHub release, mark it as pre-release save draft, set the tag to v1.11.0-rc1
|
||||
7. Wait for packages to build
|
||||
8. On all operating systems do the `Basic testing procedure`_ to ensure nothing badly broken.
|
||||
9. If any major problems are found, open an issue and fix them. If a release branch is used fix them in master and cherry pick into release branch. If the amount of changes is sufficiently large repeat from step 3. increasing rc number by one.
|
||||
10. Update version to 1.11.0
|
||||
11. Create tag
|
||||
12. Create release
|
||||
* Fill the release notes in the Release description. Preparing release notes can begin earlier. Compare current master or release branch against previous release to find all the changes. Choose the most important ones. Don't duplicate the commit log. Release notes should be a summary for people who don't want to read whole commit log. Group related changes together under titles such as "New features", "Bug Fixes", "Decompiler", "radare2" and similar.
|
||||
13. Prepare announcement tweets and messages to send in the Telegram group, reddit, and others.
|
||||
14. Close milestone if there was one
|
||||
|
||||
|
||||
|
||||
Bugfix Release
|
||||
--------------
|
||||
The process for bugfix release is similar no normal release procedure described above with some differences.
|
||||
|
||||
* Create the branch from the last tag instead of master or reuse the branch from x.y.0 release if it was already created.
|
||||
* Cherry pick required bugfixes from master into the branch.
|
||||
* Increase the third version number x.y.n into x.y.(n+1) .
|
||||
|
||||
|
||||
Basic testing procedure
|
||||
-----------------------
|
||||
|
||||
This isn't intended as exhaustive testing process, just some simple steps to make sure nothing is badly broken.
|
||||
If it makes sense repeat the step multiple times at different offsets and click around increase the chance of noticing common problems that doesn't happen 100% of time.
|
||||
|
||||
* Open a simple executable like ``/bin/ls`` or ``calc.exe``
|
||||
* Make sure that the upgraded layout isn't completely broken
|
||||
* The Disassembly widget shows proper disassembly.
|
||||
* Bundled plugins work
|
||||
* Open decompiler and select ghidra, it shows some C code at least for some functions
|
||||
* Open r2dec in decompiler widget, make sure it shows code
|
||||
* Test that sample python plugin works
|
||||
* Try debugger
|
||||
* Insert breakpoint in main
|
||||
* Start debugging
|
||||
* Go to main using function widget, make sure relocation was done correctly and you see code instead of unmapped memory and breakpoint is where you placed
|
||||
* Click continue until you hit breakpoint in main
|
||||
* Delete iaito settings file, and test that clean start works and layout isn't broken
|
||||
@@ -1,8 +0,0 @@
|
||||
Contributing Documentation
|
||||
==========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Getting Started <docs/getting-started>
|
||||
docs/building-docs
|
||||
@@ -1,37 +0,0 @@
|
||||
Building docs
|
||||
=======================
|
||||
|
||||
This page explains the steps that are needed to build Iaito's documentation.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
You will need:
|
||||
|
||||
* doxygen
|
||||
* python3
|
||||
* pip3
|
||||
|
||||
* sphinx
|
||||
* breathe
|
||||
* recommonmark
|
||||
|
||||
On Debian-based Linux distributions, the packages above can be installed with the following command.
|
||||
|
||||
.. code:: sh
|
||||
|
||||
sudo apt install make doxygen python3-pip doxygen
|
||||
sudo pip3 install sphinx breathe recommonmark
|
||||
|
||||
Then, you can build the documentation with the following commands:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
cd cutter/docs/
|
||||
make html
|
||||
|
||||
.. tip::
|
||||
|
||||
If you do not need API documentation, type ``make quick`` instead of ``make html``.
|
||||
|
||||
You can find the generated html files at ``cutter/docs/build``. Open ``cutter/docs/build/html/index.html`` with your browser to visit the index file of your local copy of the documentation.
|
||||
@@ -1,51 +0,0 @@
|
||||
Contributing documentation to Iaito
|
||||
=======================================
|
||||
|
||||
If you reached this place you were probably looking to help and improve Iaito's documentation - Fantastic, welcome aboard!
|
||||
|
||||
As many other young projects, Iaito has a problem - it lacks comprehensive documentation and written content. Thankfully, contributing to Iaito's documentation doesn’t require you to have a deep knowledge about the internals of the project. Writing, reviewing, and editing the documentation are great ways to learn about Iaito.
|
||||
|
||||
Don’t like the way something reads? Discover some information that wasn’t documented? Your pull request will be gleefully embraced.
|
||||
|
||||
.. note::
|
||||
The documentation of Iaito is written using `Sphinx and reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_. The syntax is quite straight forward and very similar to Markdown. In the future, we hope to move completely to Markdown as it is more popular.
|
||||
|
||||
|
||||
How can you help?
|
||||
-----------------
|
||||
|
||||
The following sections suggest ways you can contribute to Iaito's documentation. The list isn't complete as the possibilities are limitless.
|
||||
|
||||
The source for this documentation is available in the `docs directory <https://github.com/radareorg/cutter/tree/master/docs>`_ on Iaito's repository. This source can be generated according to the steps described in the :ref:`building docs page<contributing/docs/building-docs:Building docs>`. When the docs are updated, they are generated and pushed directly to the website at <https://cutter.re/docs>. The source for the website and blog are available on the `cutter.re's repository <https://github.com/radareorg/cutter.re>`_ and are served from the ``gh-pages`` branch.
|
||||
|
||||
.. tip::
|
||||
Document what you wished to see. If you are a user of Iaito, try to think what things you would want to see documented when you started using the project. Sometimes, the best contributions are coming from your own needs.
|
||||
|
||||
User documentation
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The documentation for users describes how to use Iaito and what the different features in Iaito do. The possibilities for contributing are endless since there are so many features that weren't even described on our docs yet. To contribute to our user documentation, all you need to do is pick a subject, widget, or functionality and document it. Describe the different visual components, how to use them, and what this feature even does.
|
||||
|
||||
Common Errors and Troubleshooting
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
As our community gets bigger, more and more people are using, installing or building Iaito on different setups. Naturally, different environments might cause different issues. The :ref:`common issues<user-docs/common-issues:Common Issues>` section in our docs aims to go over the most popular issues that you might face while using Iaito and the :ref:`building errors troubleshooting<building:Troubleshooting>` section goes over common errors that you might face while building Iaito from sources. These docs sections also explain what causes these issues and how to solve them.
|
||||
|
||||
If you know of such a common issue, whether you faced it yourself or noticed it on our community chats, it will be very helpful if you could document it and possible solutions for it.
|
||||
|
||||
|
||||
Developers documentation
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The documentation for Iaito developers aims to instruct new contributors on how to get started with developing to Iaito's codebase. It also describes best practices and development guidelines for all developers in the project. Think you have something to add to the developers' docs? We would love you to contribute.
|
||||
|
||||
API documentation
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The documentation for Iaito's API is an important reference for Iaito developers as well as Plugin developers. It thoroughly describes for developers how some functions and features work. While some of the functions are thoroughly documented, most of them aren't. Any help with improving these documentations will be blessed.
|
||||
|
||||
|
||||
Blog posts
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
We would love to see people writing and sharing their experiences with Iaito. Whether you are solving CTF challenges with Iaito, analyzing malware, finding vulnerabilities, or working on personal projects - we would love to see these published. If you have a personal blog, we would be proud to share and retweet your Iaito-related publications on our profiles, bringing you more engagement and followers. If you don't have a personal blog, we would love to host your publication on our community blog over at https://cutter.re/blog.
|
||||
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 34 KiB |
@@ -1,262 +0,0 @@
|
||||
Getting Started with Python Plugins
|
||||
===================================
|
||||
|
||||
This article provides a step-by-step guide on how to write a simple Python plugin for Iaito.
|
||||
|
||||
Create a python file, called ``myplugin.py`` for example, and add the following contents:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import cutter
|
||||
|
||||
class MyIaitoPlugin(cutter.IaitoPlugin):
|
||||
name = "My Plugin"
|
||||
description = "This plugin does awesome things!"
|
||||
version = "1.0"
|
||||
author = "1337 h4x0r"
|
||||
|
||||
def setupPlugin(self):
|
||||
pass
|
||||
|
||||
def setupInterface(self, main):
|
||||
pass
|
||||
|
||||
def terminate(self):
|
||||
pass
|
||||
|
||||
def create_cutter_plugin():
|
||||
return MyIaitoPlugin()
|
||||
|
||||
This is the most basic code that makes up a plugin.
|
||||
Python plugins in Iaito are regular Python modules that are imported automatically on startup.
|
||||
In order to load the plugin, Iaito will call the function ``create_cutter_plugin()`` located
|
||||
in the root of the module and expects it to return an instance of ``cutter.IaitoPlugin``.
|
||||
Normally, you shouldn't have to do anything else in this function.
|
||||
|
||||
.. note::
|
||||
The Iaito API is exposed through the ``cutter`` module.
|
||||
This consists mostly of direct bindings of the original C++ classes, generated with Shiboken2.
|
||||
For more detail about this API, see the Iaito C++ code or :ref:`api`.
|
||||
|
||||
The ``IaitoPlugin`` subclass contains some meta-info and two callback methods:
|
||||
|
||||
* ``setupPlugin()`` is called right after the plugin is loaded and can be used to initialize the plugin itself.
|
||||
* ``setupInterface()`` is called with the instance of MainWindow as an argument and should create and register any UI components.
|
||||
* ``terminate()`` is called on shutdown and should clean up any resources used by the plugin.
|
||||
|
||||
Copy this file into the ``python`` subdirectory located under the plugins directory of Iaito and start the application.
|
||||
You should see an entry for your plugin in the list under Edit -> Preferences -> Plugins.
|
||||
Here, the absolute path to the plugins directory is shown too if you are unsure where to put your plugin:
|
||||
|
||||
.. image:: preferences-plugins.png
|
||||
|
||||
.. note::
|
||||
As mentioned, plugins are Python modules. This means, instead of only a single .py file, you can also
|
||||
use a directory containing multiple python files and an ``__init__.py`` file that defines or imports the
|
||||
``create_cutter_plugin()`` function.
|
||||
|
||||
.. note::
|
||||
If you are working on a Unix-like system, instead of copying, you can also symlink your plugin into the plugins
|
||||
directory, which lets you store the plugin somewhere else without having to copy the files over and over again.
|
||||
|
||||
|
||||
Creating a Widget
|
||||
-----------------
|
||||
|
||||
Next, we are going to add a simple dock widget. Extend the code as follows:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import cutter
|
||||
|
||||
from PySide2.QtWidgets import QAction, QLabel
|
||||
|
||||
class MyDockWidget(cutter.IaitoDockWidget):
|
||||
def __init__(self, parent, action):
|
||||
super(MyDockWidget, self).__init__(parent, action)
|
||||
self.setObjectName("MyDockWidget")
|
||||
self.setWindowTitle("My cool DockWidget")
|
||||
|
||||
label = QLabel(self)
|
||||
self.setWidget(label)
|
||||
label.setText("Hello World")
|
||||
|
||||
class MyIaitoPlugin(cutter.IaitoPlugin):
|
||||
# ...
|
||||
|
||||
def setupInterface(self, main):
|
||||
action = QAction("My Plugin", main)
|
||||
action.setCheckable(True)
|
||||
widget = MyDockWidget(main, action)
|
||||
main.addPluginDockWidget(widget, action)
|
||||
|
||||
# ...
|
||||
|
||||
We are subclassing ``cutter.IaitoDockWidget``, which is the base class for all dock widgets in Iaito,
|
||||
and adding a label to it.
|
||||
|
||||
.. note::
|
||||
You can access the whole Qt5 API from Python, which is exposed by PySide2. For more information about this, refer to the
|
||||
Documentation of `Qt <https://doc.qt.io/qt-5/reference-overview.html>`_ and `PySide2 <https://wiki.qt.io/Qt_for_Python>`_.
|
||||
|
||||
In our ``setupInterface()`` method, we create an instance of our dock widget and an action to be
|
||||
added to the menu for showing and hiding the widget.
|
||||
MainWindow provides a helper method called ``addPluginDockWidget()`` to easily register these.
|
||||
|
||||
When running Iaito now, you should see the widget:
|
||||
|
||||
.. image:: mydockwidget.png
|
||||
|
||||
... as well as the action:
|
||||
|
||||
.. image:: mydockwidget-action.png
|
||||
|
||||
|
||||
Fetching Data
|
||||
-------------
|
||||
|
||||
Next, we want to show some actual data from the binary in our widget.
|
||||
As an example, we will display the instruction and instruction size at the current position.
|
||||
Extend the code as follows:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# ...
|
||||
|
||||
class MyDockWidget(cutter.IaitoDockWidget):
|
||||
def __init__(self, parent, action):
|
||||
# ...
|
||||
|
||||
label = QLabel(self)
|
||||
self.setWidget(label)
|
||||
|
||||
disasm = cutter.cmd("pd 1").strip()
|
||||
|
||||
instruction = cutter.cmdj("pdj 1")
|
||||
size = instruction[0]["size"]
|
||||
|
||||
label.setText("Current disassembly:\n{}\nwith size {}".format(disasm, size))
|
||||
|
||||
# ...
|
||||
|
||||
We can access the data by calling radare2 commands and utilizing their output.
|
||||
This is done by using the two functions ``cmd()`` and ``cmdj()``, which behave just as they
|
||||
do in `r2pipe <https://radare.gitbooks.io/radare2book/scripting/r2pipe.html>`_.
|
||||
|
||||
Many commands in radare2 can be suffixed with a ``j`` to return JSON output.
|
||||
``cmdj()`` will automatically deserialize the JSON into python dicts and lists, so the
|
||||
information can be easily accessed.
|
||||
|
||||
.. warning::
|
||||
When fetching data that is not meant to be used only as readable text, **always** use the JSON variant of a command!
|
||||
Regular command output is not meant to be parsed and is subject to change at any time, which will break your code.
|
||||
|
||||
In our case, we use the two commands ``pd`` (Print Disassembly) and ``pdj`` (Print Disassembly as JSON)
|
||||
with a parameter of 1 to fetch a single line of disassembly.
|
||||
|
||||
.. note::
|
||||
To try out commands, you can use the Console widget in Iaito. Almost all commands support a ``?`` suffix, like in
|
||||
``pd?``, to show help and available sub-commands.
|
||||
To get a general overview, enter a single ``?``.
|
||||
|
||||
The result will look like the following:
|
||||
|
||||
.. image:: disasm-static.png
|
||||
|
||||
Of course, since we only fetch the info once during the creation of the widget, the content never updates.
|
||||
We are going to change that in the next section.
|
||||
|
||||
|
||||
Reacting to Events
|
||||
------------------
|
||||
|
||||
We want to update the content of our widget on every seek.
|
||||
This can be done like the following:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# ...
|
||||
|
||||
from PySide2.QtCore import QObject, SIGNAL
|
||||
|
||||
# ...
|
||||
|
||||
class MyDockWidget(cutter.IaitoDockWidget):
|
||||
def __init__(self, parent, action):
|
||||
# ...
|
||||
|
||||
self._label = QLabel(self)
|
||||
self.setWidget(self._label)
|
||||
|
||||
QObject.connect(cutter.core(), SIGNAL("seekChanged(RVA)"), self.update_contents)
|
||||
self.update_contents()
|
||||
|
||||
def update_contents(self):
|
||||
disasm = cutter.cmd("pd 1").strip()
|
||||
|
||||
instruction = cutter.cmdj("pdj 1")
|
||||
size = instruction[0]["size"]
|
||||
|
||||
self._label.setText("Current disassembly:\n{}\nwith size {}".format(disasm, size))
|
||||
|
||||
|
||||
First, we move the update code to a separate method.
|
||||
Then we call ``cutter.core()``, which returns the global instance of ``IaitoCore``.
|
||||
This class provides the Qt signal ``seekChanged(RVA)``, which is emitted every time the current seek changes.
|
||||
We can simply connect this signal to our method and our widget will update as we expect it to:
|
||||
|
||||
.. image:: disasm-dynamic.png
|
||||
|
||||
For more information about Qt signals and slots, refer to `<https://doc.qt.io/qt-5/signalsandslots.html>`_.
|
||||
|
||||
Full Code
|
||||
---------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import cutter
|
||||
|
||||
from PySide2.QtCore import QObject, SIGNAL
|
||||
from PySide2.QtWidgets import QAction, QLabel
|
||||
|
||||
class MyDockWidget(cutter.IaitoDockWidget):
|
||||
def __init__(self, parent, action):
|
||||
super(MyDockWidget, self).__init__(parent, action)
|
||||
self.setObjectName("MyDockWidget")
|
||||
self.setWindowTitle("My cool DockWidget")
|
||||
|
||||
self._label = QLabel(self)
|
||||
self.setWidget(self._label)
|
||||
|
||||
QObject.connect(cutter.core(), SIGNAL("seekChanged(RVA)"), self.update_contents)
|
||||
self.update_contents()
|
||||
|
||||
def update_contents(self):
|
||||
disasm = cutter.cmd("pd 1").strip()
|
||||
|
||||
instruction = cutter.cmdj("pdj 1")
|
||||
size = instruction[0]["size"]
|
||||
|
||||
self._label.setText("Current disassembly:\n{}\nwith size {}".format(disasm, size))
|
||||
|
||||
|
||||
class MyIaitoPlugin(cutter.IaitoPlugin):
|
||||
name = "My Plugin"
|
||||
description = "This plugin does awesome things!"
|
||||
version = "1.0"
|
||||
author = "1337 h4x0r"
|
||||
|
||||
def setupPlugin(self):
|
||||
pass
|
||||
|
||||
def setupInterface(self, main):
|
||||
action = QAction("My Plugin", main)
|
||||
action.setCheckable(True)
|
||||
widget = MyDockWidget(main, action)
|
||||
main.addPluginDockWidget(widget, action)
|
||||
|
||||
def terminate(self):
|
||||
pass
|
||||
|
||||
def create_cutter_plugin():
|
||||
return MyIaitoPlugin()
|
||||
|
Before Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 20 KiB |
@@ -1,10 +0,0 @@
|
||||
Translate Iaito
|
||||
==================
|
||||
|
||||
Help Iaito by adding translations to the project!
|
||||
|
||||
Iaito is a global project with users from all around the world. We believe that Iaito should be as accessible as possible, and want our users to feel comfortable while using its interface. Providing our community an interface with their own language makes the experience of using Iaito better. Thus, Iaito supports a translation and localization mechanism powered by the `Crowdin <https://crowdin.com/project/cutter>`_ platform. We invite you to contribute and add translations to the project.
|
||||
|
||||
|
||||
.. important::
|
||||
We currently support more than 15 languages. If you need to add a language that isn't available yet, ask any developer from the team and they will happily assist you.
|
||||
|
Before Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 203 KiB |
|
Before Width: | Height: | Size: 234 KiB |
|
Before Width: | Height: | Size: 7.7 KiB |
|
Before Width: | Height: | Size: 619 KiB |
|
Before Width: | Height: | Size: 14 KiB |
@@ -1,57 +0,0 @@
|
||||
Iaito
|
||||
======
|
||||
|
||||
Iaito is a Qt and C++ GUI for radare2. Its goal is to provide an advanced,
|
||||
customizable and FOSS reverse-engineering platform while keeping the
|
||||
user experience in mind. Iaito was created by reverse engineers for
|
||||
reverse engineers.
|
||||
|
||||
.. image:: images/screenshot.png
|
||||
|
||||
|
||||
Getting Iaito
|
||||
--------------
|
||||
|
||||
Iaito is available for all major platforms. You can
|
||||
download the latest release from
|
||||
`here <https://github.com/radareorg/cutter/releases>`__.
|
||||
|
||||
- **macOS**: Download the ``.dmg`` file and install it.
|
||||
- **Windows**: Download the ``.zip`` archive and extract it.
|
||||
- **Linux**: Download the ``.AppImage`` file and make it executable by doing:
|
||||
|
||||
::
|
||||
|
||||
chmod +x Iaito*.AppImage
|
||||
|
||||
|
||||
Building from Sources
|
||||
---------------------
|
||||
|
||||
To build Iaito on your machine, please follow this guide: :doc:`Building from Source </building>`.
|
||||
|
||||
Need help?
|
||||
----------
|
||||
|
||||
You can contact the *Iaito* developers and community on:
|
||||
|
||||
- Telegram: https://t.me/iaito
|
||||
- #cutter on irc.freenode.net
|
||||
- Twitter: https://twitter.com/r2gui
|
||||
|
||||
Want to help the project?
|
||||
-------------------------
|
||||
|
||||
If you want to contribute to Iaito, take a look at our :doc:`Contribution Guidelines </contributing>` to learn how you can help improve the project!
|
||||
|
||||
.. toctree::
|
||||
:caption: Contents:
|
||||
:maxdepth: 3
|
||||
|
||||
user-docs
|
||||
contributing
|
||||
Developer documentation <contributing/code>
|
||||
building
|
||||
plugins
|
||||
api
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
Plugins
|
||||
=======
|
||||
|
||||
Iaito supports writing plugins in both C++ and Python.
|
||||
If you are unsure of which language to choose, starting with Python is strongly suggested as
|
||||
it provides a faster and simpler workflow.
|
||||
|
||||
If you plan to implement support for a new file format or architecture, Iaito plugins are not the correct approach.
|
||||
Instead, you will want to implement a radare2 plugin, which is documented `here <https://radare.gitbooks.io/radare2book/plugins/intro.html>`_.
|
||||
|
||||
|
||||
Loading and Overview
|
||||
----------------------
|
||||
|
||||
Plugins are loaded from an OS-dependent user-level directory.
|
||||
To get the location of this directory and a list of currently loaded plugins, navigate to Edit -> Preferences -> Plugins.
|
||||
|
||||
.. image:: contributing/plugins/preferences-plugins.png
|
||||
|
||||
The plugins directory contains two subdirectories, ``native`` and ``python`` for C++ and Python plugins respectively,
|
||||
which will be created automatically by Iaito.
|
||||
|
||||
.. note::
|
||||
The support for Python plugins is only available if Iaito was built with the options ``IAITO_ENABLE_PYTHON``
|
||||
and ``IAITO_ENABLE_PYTHON_BINDINGS`` enabled.
|
||||
This is the case for all official builds from GitHub Releases starting with version 1.8.0.
|
||||
|
||||
|
||||
Creating Plugins
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
||||
contributing/plugins/*
|
||||
@@ -1,22 +0,0 @@
|
||||
User Documentation
|
||||
=======================
|
||||
|
||||
This page contains information about the different menus in Iaito.
|
||||
|
||||
Iaito is an advanced reverse engineering platform powered by radare2.
|
||||
This user's guide provides detailed information on how to use Iaito.
|
||||
The documentation for users is still on its early stages and will be improved over time.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
user-docs/features
|
||||
user-docs/shortcuts
|
||||
user-docs/command-line
|
||||
user-docs/menus
|
||||
user-docs/preferences
|
||||
user-docs/common-issues
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
Command-line Options
|
||||
====================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
**Iaito** [*options*] [<*filename*>]
|
||||
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. option:: <filename>
|
||||
|
||||
Filename to open. If not specified file selection dialog will be shown.
|
||||
|
||||
.. option:: -h, --help
|
||||
|
||||
Displays help on command-line options.
|
||||
|
||||
.. option:: --help-all
|
||||
|
||||
Displays help including Qt specific options.
|
||||
|
||||
.. option:: -v, --version
|
||||
|
||||
Displays version information.
|
||||
|
||||
.. option:: -A, --analysis <level>
|
||||
|
||||
When opening a file automatically perform analysis at a given level. Requires
|
||||
:option:`<filename>` to be specified. Following levels are available:
|
||||
|
||||
**0**
|
||||
No analysis.
|
||||
|
||||
**1**
|
||||
aaa
|
||||
|
||||
**2**
|
||||
aaaa (experimental)
|
||||
|
||||
.. option:: -F, --format <name>
|
||||
|
||||
Force using a specific file format (bin plugin)
|
||||
|
||||
.. option:: -B, --base <base address>
|
||||
|
||||
Load binary at a specific base address
|
||||
|
||||
.. option:: -i <file>
|
||||
|
||||
Run script file
|
||||
|
||||
.. option:: -w, --writemode
|
||||
|
||||
Open a file in write mode, instead of the default read-only mode.
|
||||
When used together with -A/--analysis <level>, it will open a file directly
|
||||
in write mode without any further dialog or confirmation.
|
||||
|
||||
.. option:: --pythonhome <PYTHONHOME>
|
||||
|
||||
PYTHONHOME to use for the embedded python interpreter
|
||||
|
||||
.. option:: --no-output-redirect
|
||||
|
||||
Disable output redirection. Some of the output in the console widget will not
|
||||
be visible. Use this option when debugging a crash or freeze and output
|
||||
redirection is causing some messages to be lost.
|
||||
|
||||
.. option:: --no-plugins
|
||||
|
||||
Start cutter with all plugins disabled. Implies :option:`--no-cutter-plugins` and :option:`--no-r2-plugins`.
|
||||
|
||||
.. option:: --no-cutter-plugins
|
||||
|
||||
Start cutter with cutter plugins disabled.
|
||||
|
||||
.. option:: --no-r2-plugins
|
||||
|
||||
Start cutter with r2 plugins disabled.
|
||||
@@ -1,33 +0,0 @@
|
||||
Common Issues
|
||||
=============
|
||||
|
||||
This page lists common issues encountered by users.
|
||||
|
||||
AppImage Crashes
|
||||
----------------
|
||||
|
||||
If the Linux AppImage binary crashes upon startup, make sure your
|
||||
``LD_LIBRARY_PATH`` environment variable is empty.
|
||||
For a detailed explanation, see the issue `#579 <https://github.com/radareorg/cutter/issues/579>`__
|
||||
|
||||
Keyboard Layout Issue
|
||||
---------------------
|
||||
|
||||
Some people report that they have keyboard issues. Usually it is because
|
||||
the Xorg layout is wrong. You can check it with: ``setxkbmap -query``
|
||||
Most of the time using ``setxkbmap us`` solves the issue, but it might
|
||||
not be enough and require a more advanced Xorg configuration.
|
||||
|
||||
Initial Analysis takes a long time or Iaito UI freezes
|
||||
-------------------------------------------------------
|
||||
|
||||
Iaito and radare2 currently don't work very well with large and very large binaries.
|
||||
The exact limits depend on the content of the binary, but roughly a few MB can be considered large
|
||||
and may take a few minutes to analyze. More than 100MB is very large,
|
||||
analysis with default settings will likely take a very long time and it might occasionally
|
||||
freeze the UI during usage.
|
||||
|
||||
If the analysis takes longer than 5-15 minutes it is recommended to retry it with different
|
||||
analysis options. In the "Load Options" dialog, move the analysis slider to the right in order to reach
|
||||
the "Advanced Analysis" view. This view will help you learn more about the options that can
|
||||
be used to more selectively analyze only the relevant parts of code.
|
||||
@@ -1,19 +0,0 @@
|
||||
Features
|
||||
=============
|
||||
This section in the user docs gives a more detailed information about different features in Iaito. These are the different
|
||||
utilities and views that can be used and controlled by you during your session. As more familiar and comfort you feel with the
|
||||
different features in Iaito, the more efficient and effective you are during your reverse-engineering experience.
|
||||
|
||||
Decompiler
|
||||
-------------
|
||||
A decompiler is a program that will analyze binaries and attempt to create a high-level representation of the machine code in it. In other words, it tries to reconstruct the source code from which the binary was compiled in the first place.
|
||||
|
||||
Here's an image that compares one of the decompiler Iaito supports with the Iaito's disassembler.
|
||||
|
||||
.. image:: ../images/decompiler_vs_disassembly.png
|
||||
|
||||
|
||||
Iaito provides an interface that supports plugins of multiple decompilers including Ghidra, RetDec and R2Dec. The interface receives data from the decompiler and presenting the decompiler code in a context-sensitive decompiler widget. Check the `Decompilers <https://github.com/radareorg/cutter-plugins#decompilers>`_ section on our Plugins repository to know more about the decompilers we support.
|
||||
|
||||
|
||||
Out of the decompiler plugins that we support, the one that's officially maintained by the developers of Iaito is R2Ghidra. :doc:`Click here <menus/decompiler-context-menu>` to learn more about the functionalities we provide in the decompiler.
|
||||
@@ -1,13 +0,0 @@
|
||||
Menus
|
||||
======
|
||||
|
||||
This part of the user documentation will provide the reader with information about the different menus and context menu items they can find on Iaito. Each item has a description that explains about its actions, as well as how to reach this feature from the UI and a keyboard shortcut if one assigned to the feature.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:glob:
|
||||
|
||||
menus/*
|
||||
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
Breakpoints Widget Context Menu
|
||||
================================
|
||||
|
||||
|
||||
Edit a Breakpoint
|
||||
----------------------------------------
|
||||
**Description:** Open the Advanced Breakpoint Edit dialog to edit the selected breakpoint. In this dialog, you can define a software or hardware breakpoint, use conditionals, and more.
|
||||
|
||||
**Steps:** Right-click on an item in the Breakpoints widget and choose ``Edit``.
|
||||
|
||||
Toggle Breakpoint State
|
||||
----------------------------------------
|
||||
**Description:** Enable or disable a breakpoint, depending on its current state. An active breakpoint will be disabled, and an inactive breakpoint will be enabled.
|
||||
|
||||
**Steps:** Right-click on an item in the Breakpoints widget and choose ``Toggle breakpoint``.
|
||||
|
||||
**Shortcut:** :kbd:`Space`
|
||||
|
||||
Delete Breakpoint
|
||||
----------------------------------------
|
||||
**Description:** These options will disable and remove the selected breakpoint from the program.
|
||||
|
||||
**Steps:** Right-click on an item in the Breakpoints widget and choose ``Delete breakpoint``
|
||||
|
||||
**Shortcut:** :kbd:`Del`
|
||||
@@ -1,20 +0,0 @@
|
||||
Debug Buttons Toolbar
|
||||
==============================
|
||||
|
||||
Continue until Main
|
||||
----------------------------------------
|
||||
**Description:** Continue the execution of the program until the Main function is reached.
|
||||
|
||||
**Steps:** Continue until main
|
||||
|
||||
Continue until Call
|
||||
----------------------------------------
|
||||
**Description:** Continue the execution of the program until a function call is reached.
|
||||
|
||||
**Steps:** Continue until call
|
||||
|
||||
Continue until Syscall
|
||||
----------------------------------------
|
||||
**Description:** Continue the execution of the program until a Syscall is reached.
|
||||
|
||||
**Steps:** Continue until syscall
|
||||
@@ -1,129 +0,0 @@
|
||||
Decompiler Context Menu
|
||||
==============================
|
||||
The decompiler context menu is a context-sensitive menu that contains actions that are available for the position under the cursor.
|
||||
|
||||
Copy
|
||||
----------------------------------------
|
||||
**Description:** If text is selected, copy the selected text to the clipboard. If a word is highlighted, copy that word. In all other cases, copy the line under the cursor.
|
||||
|
||||
**Steps:** Right-click on a selected text and choose ``Copy``
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl-C`
|
||||
|
||||
Copy Instruction Address
|
||||
----------------------------------------
|
||||
**Description:** Copy the address of the instruction mapped to the part of the code under the cursor.
|
||||
|
||||
**Steps:** Right-click on the portion of code for which you want the instruction's address and choose ``Copy instruction address (<address>)``
|
||||
|
||||
Copy Address of Reference
|
||||
----------------------------------------
|
||||
**Description:** Copy the address of the reference under the cursor. References include functions, global variables, and constant variables with an address.
|
||||
|
||||
**Steps:** Right-click on a reference and choose ``Copy address [of <name>] (<address>)``
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl-Shift-C`
|
||||
|
||||
Show the code in another widget
|
||||
----------------------------------------
|
||||
**Description:** Show the code under the cursor in another opened widget, or open a new one. If a non-decompiler widget is chosen, the address mapped to the portion of code under the cursor will be opened in that widget.
|
||||
|
||||
**Steps:** Right-click on an item and go to the :menuselection:`Show in` submenu. You can choose a widget or open a new widget from here.
|
||||
|
||||
Show the selected item in another widget
|
||||
----------------------------------------
|
||||
**Description:** Show the selected item in another opened widget, or open a new one. Items include functions, global variables, and constant variables under the cursor.
|
||||
|
||||
**Steps:** Right-click on an item and go to the submenu :menuselection:`Show <item> in` or :menuselection:`<function name> (<address>)`. You can choose a widget or open a new widget from here.
|
||||
|
||||
Add and Edit Comment
|
||||
----------------------------------------
|
||||
**Description:** Add a comment for the line of code under the cursor or edit the comment under the cursor. The ``Edit comment`` option is only available for user-defined comments.
|
||||
|
||||
**Steps:** Right-click and choose ``Add Comment`` or ``Edit Comment``.
|
||||
|
||||
**Shortcut:** :kbd:`;`
|
||||
|
||||
Delete a Comment
|
||||
----------------------------------------
|
||||
**Description:** Delete the comment under the cursor. If a comment doesn't exist under the cursor, delete the comment at the offset mapped to the portion of code under the cursor.
|
||||
|
||||
**Steps:** Right-click on an instruction with a user-defined comment and choose ``Delete comment``
|
||||
|
||||
Rename function
|
||||
----------------------------------------
|
||||
**Description:** Rename a function under the cursor.
|
||||
|
||||
**Steps:** Right-click on a function name and choose ``Rename function <name>``
|
||||
|
||||
**Shortcut:** :kbd:`N`
|
||||
|
||||
Give a name or rename global variables
|
||||
----------------------------------------
|
||||
**Description:** Give a name or rename the global variable under the cursor.
|
||||
|
||||
**Steps:** Right-click the global variable and choose ``Add name to <address of global variable>`` or ``Rename <name>``.
|
||||
|
||||
**Shortcut:** :kbd:`N`
|
||||
|
||||
Delete the name of a global variable
|
||||
----------------------------------------
|
||||
**Description:** Delete the name of the global variable under the cursor.
|
||||
|
||||
**Steps:** Right-click on a global variable and choose ``Remove <name>``.
|
||||
|
||||
Rename Function Variable
|
||||
----------------------------------------
|
||||
**Description:** Rename local variables and arguments in the decompiled function. Note that this option is available only for function variables defined in the disassembly.
|
||||
|
||||
**Steps:** Right-click on a variable and choose ``Rename variable <name>``.
|
||||
|
||||
**Shortcut:** :kbd:`N`
|
||||
|
||||
Edit Local Variables and Arguments
|
||||
----------------------------------------
|
||||
**Description:** Rename or set the types of the function's variables and arguments. Note that this option is available only for function variables and arguments defined in the disassembly.
|
||||
|
||||
**Steps:** Right-click on a variable and choose ``Edit variable <name>``.
|
||||
|
||||
**Shortcut:** :kbd:`Y`
|
||||
|
||||
Show Cross References
|
||||
----------------------------------------
|
||||
**Description:** Show X-Refs to the reference under the cursor. This option will open Iaito's X-Refs dialog in which you will be able to see a list of X-Refs from and to the address of the reference. You can also see a preview of each cross-reference to quickly inspect the different usages. Note that references refer to function names, global variables, and constant variables with an address.
|
||||
|
||||
**Steps:** Right-click on a reference and choose ``Show X-Refs``
|
||||
|
||||
**Shortcut:** :kbd:`X`
|
||||
|
||||
|
||||
Debug Context Menu
|
||||
=======================================
|
||||
|
||||
Add or Remove Breakpoint
|
||||
-------------------------
|
||||
**Description:** Add a breakpoint at the earliest offset in the line under the cursor. If you use the keyboard shortcut to remove a breakpoint, all the breakpoints defined in the line will be removed.
|
||||
|
||||
**Steps:** Right-click on a line of code and choose :menuselection:`Breakpoint --> Add breakpoint` or :menuselection:`Breakpoint --> Remove breakpoint`.
|
||||
|
||||
**Shortcut:** :kbd:`F2`
|
||||
|
||||
Advanced Breakpoint Dialog
|
||||
----------------------------------------
|
||||
**Description:** Open the advanced breakpoint dialog. This dialog lets you define not only a regular breakpoint in this address, but also a hardware breakpoint, a conditional breakpoint, and more.
|
||||
|
||||
**Steps:** Right-click on a line of code and choose :menuselection:`Breakpoint --> Advanced breakpoint`. If multiple breakpoints are present in the line, you will be able choose the breakpoint you want to edit from the :menuselection:`Edit breakpoint` submenu.
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl-F2`
|
||||
|
||||
Continue Until Line
|
||||
----------------------------------------
|
||||
**Description:** Continue the execution of the program until it reaches the offset in the selected line. The program is not guaranteed to ever reach this address and will keep running until exited or until reached another breakpoint. If other breakpoints hit before reaching this line, they will be triggered and pause the execution. *This option is only available on Debug or Emulation modes*.
|
||||
|
||||
**Steps:** While in Debug or Emulation modes, right-click on a line of code and choose :menuselection:`Debug --> Continue until line`.
|
||||
|
||||
Set Program Counter (PC)
|
||||
----------------------------------------
|
||||
**Description:** Set the Program Counter of the debugger to the current offset. For example, on an Intel 64bit program, Iaito will set the value of the RIP register to the current address. *This option is only available on Debug or Emulation modes*.
|
||||
|
||||
**Steps:** While in Debug or Emulation modes, right-click on a line of code and choose :menuselection:`Debug --> Set PC`.
|
||||
@@ -1,122 +0,0 @@
|
||||
Disassembly Context Menu
|
||||
==============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
disassembly-context-menu/*
|
||||
|
||||
The Disassembly context menu contains actions that operate with selected instruction in disassembly and graph widgets.
|
||||
|
||||
Copy
|
||||
----------------------------------------
|
||||
**Description:** Copy the selected text.
|
||||
|
||||
**Steps:** Right-click on a selected text and choose ``Copy``
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl` + :kbd:`C`
|
||||
|
||||
Copy Address
|
||||
----------------------------------------
|
||||
**Description:** Copy the address of the location under the cursor.
|
||||
|
||||
**Steps:** Right-click on a location and choose ``Copy address``
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl` + :kbd:`Shift` + :kbd:`C`
|
||||
|
||||
Show address in another widget
|
||||
----------------------------------------
|
||||
**Description:** Show the selected address or item in another opened widget, or open a new one.
|
||||
|
||||
**Steps:** Right-click on an address or an item in instruction and choose the ``Show in`` sub-menu
|
||||
|
||||
Add Comment
|
||||
----------------------------------------
|
||||
**Description:** Add a comment in the current location.
|
||||
|
||||
**Steps:** Right-click an address and choose `Add Comment`.
|
||||
|
||||
**Shortcut:** :kbd:`;`
|
||||
|
||||
Add Flag
|
||||
----------------------------------------
|
||||
**Description:** Add a flag to the selected item or location by bookmarking and giving it a name.
|
||||
|
||||
**Steps:** Right-click an address or item and choose ``Add Flag``. This will open the Flag dialog in which you can name the location.
|
||||
|
||||
Rename
|
||||
----------------------------------------
|
||||
**Description:** Rename the flag, function or local variable at current location. If empty, remove the currently associated name.
|
||||
|
||||
**Steps:** Right-click an address or item and choose ``Rename``
|
||||
|
||||
**Shortcut:** :kbd:`N`
|
||||
|
||||
Edit Function
|
||||
----------------------------------------
|
||||
**Description:** Open the Function edit dialog in which you can define the name of the function, its start address, stack size, calling convention, and more.
|
||||
|
||||
**Steps:** Right-click on a location inside a function and choose ``Edit function``.
|
||||
|
||||
**Shortcut:** :kbd:`Shift` + :kbd:`P`
|
||||
|
||||
Re-type Local Variables
|
||||
----------------------------------------
|
||||
**Description:** Rename or set the types of the function's variables and arguments.
|
||||
|
||||
**Steps:** Right-click anywhere inside a function and then choose ``Re-type Local Variables``.
|
||||
|
||||
**Shortcut:** :kbd:`Y`
|
||||
|
||||
Delete a Comment
|
||||
----------------------------------------
|
||||
**Description:** Delete the comment at the current address. This option only available for addresses with user-defined comments.
|
||||
|
||||
**Steps:** Right-click on an instruction with a user-defined comment and choose ``Delete comment``
|
||||
|
||||
Delete a Flag
|
||||
----------------------------------------
|
||||
**Description:** Delete the flag at the current location.
|
||||
|
||||
**Steps:** Right-click on a location with a flag and choose ``Delete flag``.
|
||||
|
||||
Undefine a Function
|
||||
----------------------------------------
|
||||
**Description:** Undefine the current function. This will remove the function and its associated meta-data. You can always re-define the function, but every change that was made to the previously defined function (e.g variable renaming) would not be restored.
|
||||
|
||||
**Steps:** Right-Click on the name of the function and choose ``Undefine function``.
|
||||
|
||||
**Shortcut:** :kbd:`U`
|
||||
|
||||
Define a function
|
||||
----------------------------------------
|
||||
**Description:** Define a function starting from the current location. Iaito will automatically guess the size of the function. This can later be changed using the function editor.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Define function here``.
|
||||
|
||||
**Shortcut:** :kbd:`P`
|
||||
|
||||
Set Structure Offset
|
||||
----------------------------------------
|
||||
**Description:** Present the current value is an offset in a structure.
|
||||
|
||||
**Steps:** -> Structure offset
|
||||
|
||||
Link a Type to Address
|
||||
----------------------------------------
|
||||
**Description:** You can link type, enum or structure to a specific address. Types, structures and enums can be defined in the Types widget.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Link Type to Address``.
|
||||
|
||||
**Shortcut:** :kbd:`L`
|
||||
|
||||
|
||||
Show Cross References
|
||||
----------------------------------------
|
||||
**Description:** Show X-Refs from and to the specific location. This option will open Iaito's X-Refs dialog in which you will be able to see a list of X-Refs from and to the selected location, in addition to a preview of each cross-reference to quickly inspect the different usages.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Show X-Refs``
|
||||
|
||||
**Shortcut:** :kbd:`X`
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
Debug Context Menu
|
||||
==============================
|
||||
|
||||
Continue Until Line
|
||||
----------------------------------------
|
||||
**Description:** Continue the execution of the program until reached the selected offset. The program is not guaranteed to ever reach this address and will keep running until exited or until reached another breakpoint. If other breakpoints hit before reaching this line, they will be triggered and pause the execution. *This option is only available on Debug or Emulation modes*.
|
||||
|
||||
**Steps:** While in Debug or Emulation modes, right-click and address and choose ``Debug -> Continue until line``.
|
||||
|
||||
Set Program Counter (PC)
|
||||
----------------------------------------
|
||||
**Description:** Set the Program Counter of the debuggee to the current offset. For example, on an Intel 64bit program, Iaito will set the value of the RIP register to the current address. *This option is only available on Debug or Emulation modes*.
|
||||
|
||||
**Steps:** While in Debug or Emulation modes, right-click and address and choose ``Debug -> Set PC``.
|
||||
@@ -1,18 +0,0 @@
|
||||
Manage Breakpoints Context Menu
|
||||
================================
|
||||
|
||||
Add or Remove a Breakpoint
|
||||
----------------------------------------
|
||||
**Description:** Add a breakpoint at the current address. If a breakpoint already exists, Iaito will remove it.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Breakpoint -> Add/remove breakpoint``
|
||||
|
||||
**Shortcut:** :kbd:`F2`
|
||||
|
||||
Advanced Breakpoint Dialog
|
||||
----------------------------------------
|
||||
**Description:** Open the advanced breakpoint dialog. This dialog lets you define not only a regular breakpoint in this address, but also a Hardware breakpoint, a conditional breakpoint, and more.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Breakpoint -> Advanced breakpoint``.
|
||||
|
||||
**Shortcut:** :kbd:`Ctrl` + :kbd:`F2`
|
||||
@@ -1,26 +0,0 @@
|
||||
Patching
|
||||
==============================
|
||||
|
||||
Edit Instruction
|
||||
----------------------------------------
|
||||
**Description:** Edit the current instruction by typing a sequence of one or more instructions. Iaito will automatically fetch a preview of the bytes that are constructing the instruction.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Edit -> Instruction``
|
||||
|
||||
Edit Bytes
|
||||
----------------------------------------
|
||||
**Description:** Edit the bytes of the current instruction by typing a sequence of bytes. Iaito will automatically disassemble a preview of the instructions that are create by the typed bytes.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Edit -> Bytes``
|
||||
|
||||
NOP Instruction
|
||||
----------------------------------------
|
||||
**Description:** Fill the content of the instruction with NOP instructions. Iaito will fill the instructions with NOP as the length of the bytes constructing the instruction.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Edit -> Nop Instruction``
|
||||
|
||||
Reverse Jump
|
||||
----------------------------------------
|
||||
**Description:** On conditional jumps, Iaito will detect the inverted conditional instruction and will replace it. For example, from ``je`` to ``jne``.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Edit -> Reverse Jump``
|
||||
@@ -1,62 +0,0 @@
|
||||
Set as Code\Data\String
|
||||
==============================
|
||||
|
||||
Set as Code
|
||||
----------------------------------------
|
||||
**Description:** Set the current instruction to Code. This will force Iaito to display the current instruction as Code.
|
||||
|
||||
**Steps:** Set as... -> Code
|
||||
|
||||
**Shortcut:** :kbd:`C`
|
||||
|
||||
Set as String (auto-detect length)
|
||||
----------------------------------------
|
||||
**Description:** Set the current location to String. This will tell Iaito to treat the current address as a string and will auto-detect the length (e.g by looking for a string null-terminator).
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> String... -> Auto-detect``
|
||||
|
||||
**Shortcut:** :kbd:`A`
|
||||
|
||||
Remove string definition
|
||||
----------------------------------------
|
||||
**Description:** Remove a defined string in this address. Iaito will then treat this location as a code.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> String... -> Remove``.
|
||||
|
||||
Set as String (Advance dialog)
|
||||
----------------------------------------
|
||||
**Description:** Set the current location to String. This will open a String definition dialog in which the user will supply the length and the type (ASCII, UTF8, ...) of the string. Iaito will then treat the current address as the defined string.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> String... -> Advanced``.
|
||||
|
||||
Set as data (bytes)
|
||||
----------------------------------------
|
||||
**Description:** Convert the instruction to data of Bytes.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> Data... -> Byte``
|
||||
|
||||
Set as data (Word)
|
||||
----------------------------------------
|
||||
**Description:** Convert the instruction to data of Words.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> Data... -> Word``
|
||||
|
||||
Set as data (Dword)
|
||||
----------------------------------------
|
||||
**Description:** Convert the instruction to data of Dwords.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> Data... -> Dword``
|
||||
|
||||
Set as data (Qword)
|
||||
----------------------------------------
|
||||
**Description:** Convert the instruction to data of Qwords.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> Data... -> Qword``
|
||||
|
||||
Set as data (Advanced)
|
||||
----------------------------------------
|
||||
**Description:** Open an advanced dialog to define the custom data type of the current instruction.
|
||||
|
||||
**Steps:** Right click on an instruction and choose ``Set as... -> Data... -> ...``
|
||||
|
||||
**Shortcut:** :kbd:`*`
|
||||
@@ -1,20 +0,0 @@
|
||||
Set Current Bits
|
||||
==============================
|
||||
|
||||
Set Current Bits to 16
|
||||
----------------------------------------
|
||||
**Description:** Set the current instruction to 16-bit.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Set current bits to... -> 16``
|
||||
|
||||
Set Current Bits to 32
|
||||
----------------------------------------
|
||||
**Description:** Set the current instruction to 32-bit.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Set current bits to... -> 32``
|
||||
|
||||
Set Current Bits to 64
|
||||
----------------------------------------
|
||||
**Description:** Set the current instruction to 64-bit.
|
||||
|
||||
**Steps:** Right-click on an instruction and choose ``Set current bits to... -> 64``
|
||||
@@ -1,50 +0,0 @@
|
||||
Set Immediate Base
|
||||
==============================
|
||||
|
||||
Set Immediate Base to Binary
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to a Binary representation.
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Binary``
|
||||
|
||||
Set Immediate Base to Octal
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to an Octal representation.
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Octal``
|
||||
|
||||
Set Immediate Base to Decimal
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to a Decimal representation.
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Decimal``
|
||||
|
||||
Set Immediate Base to Hexadecimal
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to Hexadecimal.
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Hexadecimal``
|
||||
|
||||
Set Immediate Base to Network Port
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to a Network Port
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Network Port``
|
||||
|
||||
Set Immediate Base to IP Address
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to an IP Address
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> IP Address``
|
||||
|
||||
Set Immediate Base to Syscall
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to Syscall
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> Syscall``
|
||||
|
||||
Set Immediate Base to String
|
||||
----------------------------------------
|
||||
**Description:** Set the immediate value of the operand to String
|
||||
|
||||
**Steps:** Right-click on an immediate base of instruction and choose ``Set Immediate Base to... -> String``
|
||||
@@ -1,68 +0,0 @@
|
||||
Graph Widget Context Menu
|
||||
==============================
|
||||
|
||||
|
||||
Highlight Block
|
||||
----------------------------------------
|
||||
**Description:** Open the Color Picker dialog to set a background color for the selected block in the Graph view.
|
||||
|
||||
**Steps:** Right-click on a node\block in the Graph view and choose ``Highlight block``.
|
||||
|
||||
UnHighlight Block
|
||||
----------------------------------------
|
||||
**Description:** If a block in the Graph view is highlighted, this option will unhighlight it and restore the original color.
|
||||
|
||||
**Steps:** Right-click on a highlighted node\block in the Graph view and choose ``Unhighlight block``.
|
||||
|
||||
Highlight Instruction
|
||||
----------------------------------------
|
||||
**Description:** Open the Color Picker dialog to set a background color for the selected instruction in the Graph view.
|
||||
|
||||
**Steps:** Right-click on an instruction in the Graph view and choose ``Highlight instruction``.
|
||||
|
||||
UnHighlight Instruction
|
||||
----------------------------------------
|
||||
**Description:** If an instruction in the Graph view is highlighted, this option will unhighlight it and restore the original color.
|
||||
|
||||
**Steps:** Right-click on a highlighted instruction in the Graph view and choose ``Unhighlight instruction``.
|
||||
|
||||
Export Graph
|
||||
----------------------------------------
|
||||
**Description:** Export the current graph to one of the following formats:
|
||||
- PNG Image
|
||||
- JPEG Image
|
||||
- SVG Image
|
||||
|
||||
When Graphviz is installed, the following options are also available:
|
||||
- Graphviz PostScript File
|
||||
- Graphviz Dot File
|
||||
- Graphviz JSON File
|
||||
- Graphviz Gif Image
|
||||
- Graphviz PNG Image
|
||||
- Graphviz JPG Image
|
||||
- Graphviz SVG Image
|
||||
|
||||
**Steps:** Right-click anywhere on the Graph view and choose ``Export Graph``.
|
||||
|
||||
|
||||
Graph Layout Direction
|
||||
----------------------------------------
|
||||
**Description:** Graph layout direction can be either vertical top to bottom or horizontal left to right.
|
||||
|
||||
|
||||
**Steps:** Right-click anywhere on the Graph view ``Layout -> Horizontal``.
|
||||
|
||||
Choose Graph Layout
|
||||
----------------------------------------
|
||||
**Description:** Choose the layout to be used by Iaito to display the Graph. Iaito supports the following Graph layout algorithms:
|
||||
|
||||
- Grid narrow
|
||||
- Grid medium
|
||||
- Grid wide
|
||||
|
||||
When Graphviz is installed, the following options are also available:
|
||||
|
||||
- Graphviz polyline
|
||||
- Graphviz ortho
|
||||
|
||||
**Steps:** Right-click anywhere on the Graph view and choose a layout from the ``Layout`` sub-menu.
|
||||