[feature request] expand tabs option based on path

[unxed]

putty's sources use spaces. far2l uses tabs. Continuously switching between modes produces mixed files, which is mess. It would be great to have an option to configure "expand tabs" editor option differently for different paths.

[elfmz]

or may be even autodetect..

[unxed]

default editor's charset by path is also appreciated

[unxed]

Please implement if possible. Still hurts.

[elfmz]

See branch edit-live-expandtab
There was imlemented changing tabs/spaces by F5 in editor and saving tabs expansion per-file in history.
Planned improvement is Shift+F5 to allow per-file spaces count modification on the fly and may be increasing history elements count from 512 to 4096 or so.. Later will cause old histories to be lost BTW.

[unxed]

Great! Will look within a half of an hour. Maybe it is possible to detect indentation style for the first time opened files also?

[unxed]

Looks working!

[unxed]

With this simple addition I've got just that I wanted :)

diff --git a/far2l/src/fileedit.cpp b/far2l/src/fileedit.cpp
index 83373f59..c7d21392 100644
--- a/far2l/src/fileedit.cpp
+++ b/far2l/src/fileedit.cpp
@@ -1530,6 +1530,8 @@ int FileEditor::LoadFile(const wchar_t *Name,int &UserBreak)
 	EditFile.GetSize(FileSize);
 	DWORD StartTime=WINPORT(GetTickCount)();
 
+	int ConvertTabsMode = m_editor->GetConvertTabs();
+
 	while ((GetCode=GetStr.GetString(&Str, m_codepage, StrLength)))
 	{
 		if (GetCode == -1)
@@ -1589,6 +1591,14 @@ int FileEditor::LoadFile(const wchar_t *Name,int &UserBreak)
 			LastLineCR=1;
 		}
 
+		// detect indentation mode by the last string of file
+		// what starts with tab or two spaces
+		if (Str[0] == '\t') {
+			ConvertTabsMode = EXPAND_NOTABS;
+		} else if ((Str[0] == ' ') && (Str[1] == ' ')) {
+			ConvertTabsMode = EXPAND_NEWTABS;
+		}
+
 		if (!m_editor->InsertString(Str, StrLength))
 		{
 			EditFile.Close();
@@ -1596,6 +1606,33 @@ int FileEditor::LoadFile(const wchar_t *Name,int &UserBreak)
 		}
 	}
 
+	// tab mode auto detection
+	if (m_editor->GetConvertTabs() != EXPAND_ALLTABS) {
+		m_editor->SetConvertTabs(ConvertTabsMode);
+	}
+
+	// trying to apply .editorconfig setting
+	// sudo apt-get install editorconfig
+	wchar_t command[4137];
+	std::wstring NameStr = Name;
+	QuoteCmdArg(NameStr);
+	swprintf(command, 4136, L"editorconfig %ls | grep indent_style=space", NameStr.c_str());
+	if (!system(Wide2MB(command).c_str())) {
+		m_editor->SetConvertTabs(EXPAND_NEWTABS);
+	}
+	swprintf(command, 4136, L"editorconfig %ls | grep indent_style=tab", NameStr.c_str());
+	if (!system(Wide2MB(command).c_str())) {
+		m_editor->SetConvertTabs(EXPAND_NOTABS);
+	}
+	swprintf(command, 4136, L"editorconfig %ls | grep tab_width=2", NameStr.c_str());
+	if (!system(Wide2MB(command).c_str())) {
+	    m_editor->SetTabSize(2);
+	}
+	swprintf(command, 4136, L"editorconfig %ls | grep tab_width=4", NameStr.c_str());
+	if (!system(Wide2MB(command).c_str())) {
+	    m_editor->SetTabSize(4);
+	}
+
 	BadConversion = !GetStr.IsConversionValid();
 	if (BadConversion)
 	{

[akruphi]

See branch edit-live-expandtab There was imlemented changing tabs/spaces by F5 in editor and saving tabs expansion per-file in history. Planned improvement is Shift+F5 to allow per-file spaces count modification on the fly and may be increasing history elements count from 512 to 4096 or so.. Later will cause old histories to be lost BTW.

Extra fine! Very useful features! But it required clear simple info about current mode. In top status line in Editor some info will be useful:

• number of current tab spaces
• TAB as \t or expand to spaces
• sign about on/off tab autodetection

For example may be it write as:
AT8 - autodetect tab as \t 8 symbols
S4 - manually tab as 4 spaces
etc

[akruphi]

May be useful also add in Editor switch to show spaces, tabs and new lines as special symbols (may be more gray than standard text color). For example: each space as · U+00B7, tab as U+21E5 ⇥ or U+21B9 ↹, new lines as U+21B5 ↵, carriage return as ??? (not now idea).

[elfmz]

There is already option Show white space in F9/Options/Editor settings

[akruphi]

There is already option Show white space in F9/Options/Editor settings

Ooops! Fine! Please add keyboard shortcut to on/off show white space in Editor on-fly. May be by F3 or F9, which now free.

[elfmz]

Whitespaces toggling added on Ctrl+F5. This however not saved per file, should it be? IMHO not, but can reconsider..

[elfmz]

Merged to master, regarding autodetection - may be will do it as an extra option, i just afraid that it will be too much unpredictable

[unxed]

Merged to master, regarding autodetection - may be will do it as an extra option, i just afraid that it will be too much unpredictable

Let user decide: it may be enabled as fourth "expand tabs" option: "expand new tabs if no tabs present in file".

[unxed]

There are several examples of tab detection, may be it worth looking at them to select best logic:
https://unix.stackexchange.com/a/478448

[elfmz]

Its still heuristics, no matter how its done. Also, i think if implementing this then need also check 'sibling' files in same in case new file being created or in case algorithm assumed unreliable decision.

[unxed]

check 'sibling' files

Sounds good

[unxed]

When you press F5 in tab mode, all tabs in the file are replaced with spaces. I do not think it's a good idea. It would be better to switch to tab mode 2, rather than tab mode 1, so that the switch only affects newly entered characters, not existing ones.

[elfmz]

may be its better to save tabs state only if it was modified explicitly (by F5)? and keep default if it wasnt?

[unxed]

may be its better to save tabs state only if it was modified explicitly (by F5)? and keep default if it wasnt?

agree

[akruphi]

Whitespaces toggling added on Ctrl+F5. This however not saved per file, should it be? IMHO not, but can reconsider..

Thank you. Very useful features, which usually need in moment to verify real formatting (now in far2l show contrast bright white-spaces with colors equal to text not comfort during regular editing). I think it not need to save individually per file.

For me toggle white-space more often action then change tab spaces and may be if it possible switch toggling to 1-key (may be from Clrt+F5 to F3), but here I not sure.

[elfmz]

first i suspect that other still free keys can be used by plugins or by some future useful functionality so i don't like reserving all F-s right now, second all that whitespaces/tabs-to-space convertions are similar and so looks better to be on same F with different mods...

[akruphi]

first i suspect that other still free keys can be used by plugins or by some future useful functionality so i don't like reserving all F-s right now, second all that whitespaces/tabs-to-space convertions are similar and so looks better to be on same F with different mods...

I agree. Thank you for efforts & fine far2l. May be change F5 to toggle white-space and Ctrl+F5 to toggle space/tab mode? What opinion @unxed about what action more often change tabs or show white-space?

[unxed]

No opinion. Should use new features for a while before making conclusions. Also, my UX is specific: I use tabs auto detection patch, so do not need to switch tab mode manually often. With all it's simplicity, for all source code files I've tested it with it gave me no failed detections. It uses the last line of the file what starts with a tab character or two spaces to determine the type of indentation. There is sometimes mixed formatting at the beginning of source code files due to different headers and comments, using end of file for auto detection works better because the end of any source code file usually looks something like this:

    }
}

[unxed]

As for determining the tab mode for new files, I could not come up with a sufficiently reliable algorithm. What if it's the first file in the folder? What to do with files with different extensions, like .c and .h? Probably the only reliable solution would be to use per-folder configuration files .far2l with contents like

[Editor]
ExpandTabs=2

If no such file is found in the current folder, far2l should look in parent folders through directory tree up to the root folder. If still no such file found, auto detection should be used, and for the new files global editor setting should be used. Both features, per-folder configuration and tab mode detection should be implemented as optional, being enabled in global configuration like:

[x] Enable per-folder .far2l config files support // enabled by default
[ ] Enable tab mode auto detection // disabled by default

With both whose checkboxes disabled far2l should behave just like it behaves now.

Also auto detection may be improved by asking user explicitly during opening file:
"Tab indentation detected in file, but expanding tabs to spaces is enabled. Do you want to switch expanding tabs to spaces off for this file to avoid mixed indentation?"

[elfmz]

maybe this?
https://editorconfig.org/

[unxed]

https://editorconfig.org/

Looks good!

[unxed]

Wow, libeditorconfig is even available in Ubuntu/Fedora/brew repos!

~$ sudo apt-get install editorconfig
Чтение списков пакетов… Готово
Построение дерева зависимостей… Готово
Чтение информации о состоянии… Готово
Будут установлены следующие дополнительные пакеты:
  libeditorconfig0
Следующие НОВЫЕ пакеты будут установлены:
  editorconfig libeditorconfig0

[elfmz]

format doesnt look as something much more than usual ini file with few simple extensions so better to avoid extra dependency

[unxed]

It turns out that several projects I work with already use this format. It's great if far2l starts supporting it out of the box!

[akruphi]

Because now active working with the editor may be also implemented in it quick switching F8 between not only OEM<->ANSI, but also UTF8<->OEM<->ANSI (it will closed #1179). May be even realize for user customization codepages for F8.

[elfmz]

i thought there can be no conflicting rules, now i see that it can and must be ordered, so need some corrections.. Regarding ** - its also not yet supported

[unxed]

Also I have some problems with my .editorconfig files for far2l, checked on vanilla editorconfig tool, need some fixes. Please apply #1530.

[unxed]

Still problems :) See calc/.editorconfig, then try to edit calc/src/shared/sgml/tools.cpp.
Far opens it as T4, but command line editorconfig tool reports another settings:

charset=utf-8
end_of_line=lf
indent_style=space
indent_size=2
tab_width=2

[unxed]

After some experiments I found that far2l treats sections names with relative paths as if we are in folder of file edited, even if applied section is from file located in one of parent folders.

[elfmz]

There are 2 hard problems in computer science: cache invalidation, naming things, and off-by-1 errors

[unxed]

Thanks!

In the meantime, I made some attempt to get rid of the mixed indentation in the sources, take a look: #1532 (build error fixed!).

By the way, how about running sources (excluding ones that are often upstream-synced) through astyle utility for consistent indentation style and code beautifulness? I experimented with it, works great. And for the cmake there is cmake-format that does the same job.

UPD: Verified all far2l's .editorconfig files, now everything seem to work fine, great!

[elfmz]

I suddenly found that Alt+Shift+F9 in editor opens 'local' editor configuration. However it doesnt work for some reason per se, but works if press Win+Shift+F9.
So two questions arose then:

1. Why so tricky combination for such useful dialog, why not simple F9 that is free in Editor?
2. Given if reassign this to F9 - is recently added F5 and related really needed?

[elfmz]

Same for Viewer BTW

[unxed]

Win+Shift+F9

Not working for me :(

[unxed]

In tty-xi Shift-Alt-F9 works fine. Cool thing! Still, tab mode hot keys were very useful during mixed indentation removal that I did in last few days.

[elfmz]

I have language switcher at Alt+Shift, may be this prevents Alt+Shift+F9. So i will reassign it to F9, as Alt+Shift+F9 not obvious and as found - not working sometimes..

[unxed]

btw, what is preferred way of indenting multi line if statements when using tabs? With space indentation I can write something like:

if (
    (a == b) &&
    (c == d)
   )
{
    doStuff();
}

but with tabs indentation it becomes less beautiful:

if (
	(a == b) &&
	(c == d)
	)
{
    doStuff();
}

Or maybe such alignments are not welcomed at all when indenting is done via tabs?

[unxed]

Btw, github announces .editorconfig support, but diffs are still viewed with 8-space-tabs. What am I doing wrong?

[elfmz]

here tabs are 4-char width: https://github.com/elfmz/far2l/pull/1552/files#diff-89ea3df56433c13f951b7217273c7fc6592e3a11717371ff0e86c81608e2d7f2
but here - 8 chars: https://github.com/elfmz/far2l/pull/1552/files#diff-21847a235dcc6273022093fe4774149f8cc3474ee845d553dee393edfb3d227d

[unxed]

strange thing. both files should share the same .editorconfig settings

[elfmz]

May be it takes .editorconfig from 'old' revision?