Merge branch 'elfmz:master' into master

Author: unxed

.github/workflows/build.yml

@@ -176,6 +176,7 @@ jobs:
           libssl-dev libsmbclient-dev libnfs-dev libneon27-dev libssh-dev
           libarchive-dev
           python3-dev python3-cffi
+          python3-markdown appstream
   
       - name: Create Build Environment
         # Create a separate build directory as working directory for all subsequent commands
@@ -195,6 +196,9 @@ jobs:
         # Execute the build.  You can specify a specific target with "--target <NAME>"
         run: |
           cmake --build _build --config $BUILD_TYPE -j$(nproc --all)
+
+      - name: Validate AppStream metainfo file
+        run: appstreamcli validate --strict _build/far2l/DE/io.github.elfmz.far2l.metainfo.xml
 
   macos14-arm64-clang15:
     if: ${{ !(github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository != 'elfmz/far2l') }}

HACKING.md

@@ -89,7 +89,7 @@ far2l uses this to resolve symlink destination when user selects plugin's item t
 * `DM_SETTEXTPTRSILENT`
 * `ECTL_ADDTRUECOLOR` - applies coloring to editor like ECTL_ADDCOLOR does but allows to specify 24 RGB color using EditorTrueColor structure.
 * `ECTL_GETTRUECOLOR` - retrieves coloring of editor like ECTL_GETCOLOR does but gets 24 RGB color using EditorTrueColor structure.
-* `DN_KEY` - Param2 retrives bitmasked state of the keys KEY_SHIFT, KEY_ALT and KEY_CTRL when Param1 equals to 0
+* `DN_KEY` - Param2 retrives bitmasked state of the keys KEY_SHIFT, KEY_ALT and KEY_CTRL when Param1 equals to -1.
 
 Note that all true-color capable messages extend but don't replace 'base' 16 palette colors. This is done intentionally as far2l may run in terminal that doesn't support true color palette, and in such case 24bit colors will be ignored and base palette attributes will be used instead.
 

README.md

@@ -6,7 +6,7 @@ Works also on OSX/MacOS and BSD (but latter not tested on regular manner)
 BETA VERSION.   
 **Use on your own risk!**
 
-Plug-ins that are currently working: NetRocks (SFTP/SCP/FTP/FTPS/SMB/NFS/WebDAV), colorer, multiarc, tmppanel, align, autowrap, drawline, editcase, SimpleIndent, Calculator, Python (optional scripting support)
+Plug-ins that are currently working: NetRocks (SFTP/SCP/FTP/FTPS/SMB/NFS/WebDAV), colorer, multiarc, tmppanel, Advanced compare, filecase, inside, align, autowrap, drawline, editcase, editorcomp, incsrch, SimpleIndent, Calculator, Python (optional scripting support)
 
 FreeBSD/MacOS (Cirrus CI): [![Cirrus](https://api.cirrus-ci.com/github/elfmz/far2l.svg)](https://cirrus-ci.com/github/elfmz/far2l)
 
@@ -22,13 +22,30 @@ FreeBSD/MacOS (Cirrus CI): [![Cirrus](https://api.cirrus-ci.com/github/elfmz/far
 * 7z ANSI-C Decoder
 * utf-cpp by ww898
 
+### Jump To:
+* [Getting Started](#gstarted)
+* [Installing, Running](#inst_run)
+* [Building, Contributing, Hacking](#building)
+* [Compatible Terminals and SSH clients](#terminals)
+* [Useful 3rd-party extras](#useful3party)
+* [Community packages & binaries](#community_bins)
+* See also (in external documents):
+    * [Change log](changelog.md)
+    * [Releases](https://github.com/elfmz/far2l/releases)
+    * [Notes on porting and FAR Plugin API changes](HACKING.md)
+    * [Coding style](CODESTYLE.md)
+    * [Testing](testing/README.md)
+
+<a name="gstarted"></a>
+## Getting Started
+
 <sub><a name="keyshells"></a>_Note_: Far2l uses keyboard shortcurts in the tradition of the Far Manager for Windows,
-but some of them (**Alt**-**F1**, **Alt**-**F2**, **Alt**-**F7**, **Ctrl**-arrows, etc.)
+but some of them (**Alt**+**F1**, **Alt**+**F2**, **Alt**+**F7**, **Ctrl**+arrows, etc.)
 usually exclusively used in desktop environment GNOME, KDE, Xfce, macOS etc. and in terminal emulators.
 To work with these keys in far2l you need to _release keyboard shortcuts globally_
 in the environment settings (see [#2326](https://github.com/elfmz/far2l/issues/2326))
 or use far2l lifehacks:
-_Sticky controls via **Ctrl**-**Space** or **Alt**-**Space**_ or _Exclusively handle hotkeys option in the Input settings_
+_Sticky controls via **Ctrl**+**Space** or **Alt**+**Space**_ or _Exclusively handle hotkeys option in the Input settings_
 (see details in buil-in far2l help).</sub>
 
 ### UI Backends
@@ -76,6 +93,7 @@ and in **terminal settings** option OSC 52 must be allowed (by default, OSC 52 i
 OSC 52 in many terminals is implemented only for the copy mode, and paste from the terminal goes by bracketed paste mode).</sub>
 
 
+<a name="inst_run"></a>
 ## Installing, Running
 <a name="debian"></a>
 #### Debian/Ubuntu binaries from the official repositories
@@ -136,6 +154,7 @@ docker run -it far2l
 See also [Community packages & binaries](#community_bins)
 
 
+<a name="building"></a>
 ## Building, Contributing, Hacking
 #### Required dependencies
 
@@ -149,6 +168,7 @@ See also [Community packages & binaries](#community_bins)
 * `libsmbclient-dev` (_optional_ - needed for **NetRocks/SMB**)
 * `libnfs-dev` (_optional_ - needed for **NetRocks/NFS**)
 * `libneon27-dev` (or later, _optional_ - needed for **NetRocks/WebDAV**)
+* [AWS SDK S3](https://github.com/aws/aws-sdk-cpp) (_optional_ - needed for **NetRocks/AWS**)
 * `libarchive-dev` (_optional_ - needed for better archives support in **multiarc**)
 * `libunrar-dev` (_optional_ - needed for RAR archives support in **multiarc**, see `-DUNRAR` command line option)
 * `libicu-dev` (_optional_ - needed if used non-default ICU_MODE, see `-DICU_MODE` command line option)
@@ -207,7 +227,7 @@ To force-disable TTY|X and TTY|Xi backends: add argument `-DTTYX=no`; to disable
 
 To eliminate libuchardet requirement to reduce far2l dependencies by cost of losing automatic charset detection functionality: add `-DUSEUCD=no`
 
-By default far2l uses pre-generated "hardcoded" UNICODE characters properties. But this can be changed by specifying -DICU_MODE when configuring cmake:
+By default far2l uses pre-generated "hardcoded" UNICODE characters properties. But this can be changed by specifying `-DICU_MODE` when configuring cmake:
  `-DICU_MODE=prebuilt` - is a described above default implementaion. Most dependency-less option.
  `-DICU_MODE=build` - re-generate characters properties during build by using libicu available on build system, but it still not required to be present on target.
  `-DICU_MODE=runtime` - obtain properties at runtime (that can be bit slower) using libicu that required to be present on target system.
@@ -338,7 +358,7 @@ You can import the project into your favourite IDE like QtCreator, CodeLite, or
  * **Visual Studio Code** (required _CMake Tools extension_): open far2l root directory (by default building in subdirectory `_build`; you can change in `.vscode/settings.json`)
 
 <a name="terminals"></a>
-## Terminals and SSH clients
+## Compatible Terminals and SSH clients
 Supporting extended far2l keyboard shortcuts and clipboard access
 
  * **kovidgoyal's kitty** (Linux/BSD, macOS): https://github.com/kovidgoyal/kitty & https://sw.kovidgoyal.net/kitty (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l and kitty for clipboard support)
@@ -354,12 +374,14 @@ Supporting extended far2l keyboard shortcuts and clipboard access
    * **putty4far2l** (Windows ssh-client): https://github.com/ivanshatsky/putty4far2l/releases & https://github.com/unxed/putty4far2l (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
    * **cyd01's KiTTY** (Windows ssh-client): https://github.com/cyd01/KiTTY & https://www.9bis.net/kitty (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
    * **putty-nd** (Windows ssh-client): https://sourceforge.net/projects/putty-nd & https://github.com/noodle1983/putty-nd (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
-   * **PuTTY 0.82+**: since 0.82 in vanilla PuTTY you can set keyboard settings `Xterm 216+` and `xterm-style bitmap` (see: https://github.com/elfmz/far2l/issues/2630 )
+   * **PuTTY 0.82+**: since 0.82 in vanilla PuTTY you can set keyboard settings `Xterm 216+` and `xterm-style bitmap` (see: https://github.com/elfmz/far2l/issues/2630 ),
+but vanilla PuTTY can not transfer clipboard.
 
 _Note_: to full transfer extended keyboard shortcuts and the clipboard to/from the **remote far2l**
 one of the best way to initiate the connection **inside local far2l-GUI**
 (see details in build-in help section **UI backends**).
 
+<a name="useful3party"></a>
 ## Useful 3rd-party extras
 
  * A collection of macros for far2l: https://github.com/corporateshark/far2l-macros

changelog.md

@@ -0,0 +1,70 @@
+# far2l changelog
+
+Only significant user-side changes are listed here (for all changes see history of [Commits](https://github.com/elfmz/far2l/commits/master/) and [Pull requests](https://github.com/elfmz/far2l/pulls?q=is%3Apr+is%3Aclosed)).
+
+## Master (current development)
+* _New:_ Different desktop files for launch WX (GUI) `--notty` and TTY `--tty`
+* _New:_ Horizontal panels layout (toggle horizontal-vertical by **Ctrl+,**)
+* _New:_ Groups of file masks
+* _New:_ "Files highlighting and sort groups" dialog short/full view by **Ctrl+M**
+* _New:_ Customize Size column in panels (all by dialog or **Ctrl+Alt+D**, symlinks by **Ctrl+Alt+L**)
+* More customize dirs/files markers in panels (by dialog or **Ctrl+Alt+M** and **Ctrl+Alt+N**)
+* _New:_ Link item in File menu (in addition to the usual **Alt+F6**)
+* _New:_ Chattr / chflags with all flags for single file (in File menu or by **Ctrl+Alt+A**)
+* _New:_ Python-subplugin: copy/paste files via clipboard - wx ONLY version - with support for gnome clipboard types, works with gnome files/nautilus
+* _New:_ At 1st run detect Russian locale
+* _New:_ At 1st run show OSC52 info (if need)
+* _New:_ Far colors moved to farcolors.ini
+* Help actualization and improvements
+* Info panel: New EditorConfig block
+* _colorer plugin_: Update colorer schemes to v1.2.0.57
+* _Inside plugin_: Add PE format, add png, ogg, m4a and Mach-O support
+* _multiarc plugin_: Removed PCRE library dependencies
+* _NetRocks plugin_: Explicit SSH algorithms options
+* _NetRocks plugin_: Add AWS S3 protocol support (_optional compilation if AWSSDK installed_)
+* _python plugin_: New subplugin **hex editor**
+* _python plugin_: Removed debugpy dependencies
+* _Temporary panel plugin_: Significant fixes, tweaks and improvements
+* optional ability to use icu available on build system or target
+* Several bugfixes
+
+## 2.6.4 beta (2024-11-18)
+* _New:_ icons and a desktop file for far2ledit
+* _New:_ Default Files highlighting with dirs/files markers a la `mc` and `ls -F`
+* _New:_ Panels customization align filenames by marks (by dialog and **Ctrl+Alt+M**)
+* Info panel: add hide/show blocks + additions in file systems info and tuning git status
+* _New:_ **Ctrl-Alt-\\** quick jump to the mount point of the current folder's file system
+* Enable esc expiration if we've got no TTY|X or got TTY|X without Xi (`--ee` no need more)
+* _New:_ Add special commands `edit:<` and `view:<` for grab redirect output
+* _New:_ Extend `--nodetect` option to cover win32/iTerm2/kovidgoyal's kitty modes
+* _New:_ Add bash-completion
+* _colorer plugin_: Update colorer lib to v1.4.1
+* _colorer plugin_: Change logger library
+* _multiarc plugin_: Update bundled 7z sources to 2408
+* _multiarc plugin_: Update bundled unrar sources to 7.0.9
+* _python plugin_: New subplugins
+* _python plugin_: Build changes and requirements
+* Several bugfixes
+
+## 2.6.3 beta (2024-07-26)
+* Several bugfixes
+
+## 2.6.2 beta (2024-07-16)
+* _New:_ Case (in)sensitive option for file masks in Find file
+* _New:_ Case (in)sensitive option for Compare folders and (De)Select in Panels
+* _New:_ Attributes dialog (by **Ctrl+A**) - dynamically show marks (\*) near changed fields
+* _New:_ Option to disable automatic highlights in history lists
+* _New:_ Commands History - delete duplicates if Name and Path equal (customization via System settings)
+* _New:_ Datetime format customization via Interface settings
+* _New:_ RGB in far2l Palette
+* Several bugfixes
+
+## 2.6.1 beta (2024-04-14)
+## 2.6.0 beta (2024-02-19)
+## 2.5.3 beta (2023-11-05)
+## 2.5.3 beta (2023-11-05)
+## 2.5.2 beta (2023-08-15)
+## 2.5.1 beta (2023-05-28)
+## 2.5.0 beta (2023-01-15)
+## 2.4.1 beta (2022-09-25)
+## 2.4.0 beta (2022-01-12)

colorer/src/Colorer-library/src/colorer/strings/legacy/UnicodeString.h

@@ -3,6 +3,7 @@
 
 #include <colorer/strings/legacy/CommonString.h>
 #include <memory>
+#include <cstdint>
 
 class CString;
 

far2l/CMakeLists.txt

@@ -300,4 +300,34 @@ else()
         DESTINATION "share/applications"
         COMPONENT desktop
         PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ WORLD_READ WORLD_EXECUTE)
+
+    find_package(Python3 COMPONENTS Interpreter)
+
+    if(Python3_Interpreter_FOUND)
+        execute_process(COMMAND "${Python3_EXECUTABLE}" -c "import markdown"
+                        RESULT_VARIABLE PYTHON_MARKDOWN_STATUS
+                        OUTPUT_QUIET
+                        ERROR_QUIET)
+
+        if(PYTHON_MARKDOWN_STATUS EQUAL 0)
+            add_custom_command(TARGET far2l POST_BUILD
+                               COMMAND ${Python3_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/DE/generate_metainfo.py"
+                                       "${CMAKE_SOURCE_DIR}/changelog.md"
+                                       "${CMAKE_CURRENT_SOURCE_DIR}/DE/io.github.elfmz.far2l.metainfo.xml.in"
+                                       "${CMAKE_CURRENT_BINARY_DIR}/DE/io.github.elfmz.far2l.metainfo.xml"
+                               DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/DE/generate_metainfo.py"
+                                       "${CMAKE_SOURCE_DIR}/changelog.md"
+                                       "${CMAKE_CURRENT_SOURCE_DIR}/DE/io.github.elfmz.far2l.metainfo.xml.in"
+                               COMMENT "Generating DE/io.github.elfmz.far2l.metainfo.xml"
+                               VERBATIM)
+            install(FILES "${CMAKE_CURRENT_BINARY_DIR}/DE/io.github.elfmz.far2l.metainfo.xml"
+                    DESTINATION "share/metainfo"
+                    COMPONENT desktop)
+        else()
+            message(WARNING "Python-Markdown not found. Skipping AppStream metainfo generation.")
+        endif()
+    else()
+        message(WARNING "Python3 interpreter not found. Skipping AppStream metainfo generation.")
+    endif()
+
 endif()

far2l/DE/generate_metainfo.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+import markdown
+import re
+import sys
+import xml.etree.ElementTree as ET
+
+[changelog_file, xml_template_file, xml_output_file] = sys.argv[1:]
+
+with open(changelog_file) as fp:
+    md_text = fp.read()
+
+html_content = markdown.markdown(md_text)
+html_root = ET.fromstring(f"<root>{html_content}</root>")
+release_re = re.compile(r"(?P<version>[\d.]+) (?P<type>[a-z]+) \((?P<date>\d{4}-\d{2}-\d{2})\)")
+
+tree = ET.parse(xml_template_file)
+releases = tree.getroot().find("releases")
+release_elem = None
+
+for elem in html_root:
+    if elem.tag == "h2":
+        if elem.text[0].isdecimal():
+            match = release_re.match(elem.text)
+            release = match.groupdict()
+            if release["type"] == "beta":
+                release["type"] = "development"
+            release_elem = ET.SubElement(releases, "release", release)
+    elif elem.tag == "ul" and release_elem is not None:
+        for child_elem in elem.iter():
+            # https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description
+            if child_elem.tag == "strong":
+                child_elem.tag = "em"
+        desc_elem = ET.SubElement(release_elem, "description")
+        desc_elem.append(elem)
+
+ET.indent(tree)
+tree.write(xml_output_file, encoding="utf-8", xml_declaration=True)

far2l/DE/io.github.elfmz.far2l.metainfo.xml.in

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="desktop-application">
+  <id>io.github.elfmz.far2l</id>
+
+  <name>far2l</name>
+  <summary>Linux port of FAR v2</summary>
+  <categories>
+    <category>Utility</category>
+    <category>FileManager</category>
+    <category>System</category>
+    <category>FileTools</category>
+  </categories>
+  <url type="homepage">https://github.com/elfmz/far2l</url>
+  <developer id="io.github.elfmz">
+    <name>elfmz</name>
+  </developer>
+  <content_rating type="oars-1.1"/>
+
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>GPL-2.0 and BSD-3-Clause</project_license>
+
+  <description>
+    <p>
+      This is a clone of FAR manager for Windows, similar, but more powerful than Norton Commander/Midnight Commander.
+    </p>
+    <p>
+      Plug-ins that are currently working:
+    </p>
+    <ul>
+      <li>align</li>
+      <li>autowrap</li>
+      <li>calc</li>
+      <li>colorer</li>
+      <li>compare</li>
+      <li>drawline</li>
+      <li>editcase</li>
+      <li>editorcomp</li>
+      <li>filecase</li>
+      <li>incsrch</li>
+      <li>inside</li>
+      <li>multiarc</li>
+      <li>NetRocks (SFTP/SCP/FTP/FTPS/SMB/NFS/WebDAV)</li>
+      <li>python</li>
+      <li>SimpleIndent</li>
+      <li>tmppanel</li>
+    </ul>
+  </description>
+
+  <launchable type="desktop-id">far2l.desktop</launchable>
+
+  <releases/>
+</component>