#1158 OmegaT does not check errors when tag errors are not present

[Jean-Christophe Helary]

When tag errors are present, OmegaT checks all the error types.

When tag errors are not present, OmegaT does not try to detect other kinds of errors.

OmegaT should check errors of all types even if there are no tag errors.

[Hiroshi Miura]

TagValidationTool#checkEntry do not have any logic to skip error checks other than no-translated entry.
Furhter investigation is impossible without reproduceable data and senario.

    /**

     * Checks entry for valid tags.
     *
     * @return An {@link ErrorReport} summarizing the results (will be empty if
     *         no issues found)
     */
    private ErrorReport checkEntry(FileInfo fi, SourceTextEntry ste, TMXEntry te) {

        ErrorReport report = new ErrorReport(ste, te);

        // if there's no translation, skip the string bugfix for:
        // https://sourceforge.net/p/omegat/bugs/64/
        if (!te.isTranslated() || ste.getSrcText().isEmpty()) {
            return report;
        }

        // Check printf variables
        if (Preferences.isPreference(Preferences.CHECK_ALL_PRINTF_TAGS)) {
            TagValidation.inspectPrintfVariables(false, report);
        } else if (Preferences.isPreference(Preferences.CHECK_SIMPLE_PRINTF_TAGS)) {
            TagValidation.inspectPrintfVariables(true, report);
        }

        // Extra checks for PO files:
        if (fi.filterClass.getCanonicalName().equals("PoFilter")) {
            TagValidation.inspectPOWhitespace(report);
        }

        TagValidation.inspectOmegaTTags(ste, report);

        if (Preferences.isPreference(Preferences.CHECK_JAVA_PATTERN_TAGS)) {
            TagValidation.inspectJavaMessageFormat(report);
        }

        TagValidation.inspectRemovePattern(report);

        return report;
    }

[Jean-Christophe Helary]

I'll prepare something later. Thank you.

[Hiroshi Miura]

When no reproducible given, I'd like to close the issue.

[Jean-Christophe Helary]

Sorry, it's on my "todo" list. I'll be on it shortly.

[Jean-Christophe Helary]

See here:
https://sourceforge.net/p/omegat/bugs/1225/?limit=25#8cc4/2a02/1a77/7acf

The check I mention is the automatic check made when leaving a segment.

[Kos Ivantsov]

I think the more consistent behavior would be for this option to be renamed to reflect that it deals with tags (its intention is rather obvious from the code). And then this option and the option in the Preferences > Tag Processing that prevents creating target documents with tag issues should temporarily disable any other checks selected in the Check Issues and cover only tags.

Both of these options are about files validity, not about QA.

[Jean-Christophe Helary]

What I’d like to know is whether the function was coded before we had all the other checks and then forgotten about, hence the inconsistency that we need to fix, or if it intended to leave them aside, in which case I'd be fine with temporarily reverting the labels.

I wrote that bug report because I wanted OmegaT to check for all the issues on leaving the segment and it did not do that.

[Kos Ivantsov]

What I’d like to know is whether the function was coded before we had all the other checks and then forgotten about, hence the inconsistency that we need to fix, or if it intended to leave them aside, in which case I'd be fine with temporarily reverting the labels.

When it was added, we had only tag validation. Everything else was (and still is) available in the QA script. Then tag validation was retired and superseded by the Check Issues which is designed to be extendable by scripts and plugins. When it was done, I think very little though was given to automatic tag validation which would happen when leaving a segment and creating target files. Tag validation is relatively simple task as far as computing goes, but even on medium-sized projects it might slow things down. Add to that compute-hungry terminology checks and LanguageTool, and it becomes a real annoyance if it pops up every now and then.

I wrote that bug report because I wanted OmegaT to check for all the issues on leaving the segment and it did not do that.

Fair enough, but I think with the current implementation of the Check Issues function with the scope always being an entire current document, it is not a very good idea. If somehow the check could be limited to the segment only, that would be quite helpful.

[Jean-Christophe Helary]

I totally agree with you about limiting the scope to the current segment, in that particular case.

[Hiroshi Miura]

I agree with Kos’s explanation regarding the historical background and the current architectural constraints.

Technical Summary

• The automatic check triggered when leaving a segment was originally implemented only for tag validation.
• Later, tag validation was replaced by Check Issues, which introduced heavier checks (terminology, LanguageTool, scripts/plugins).
• The current Check Issues system always operates on the entire document, so extending the per-segment automatic check to full QA would cause performance issues on medium or large projects.

Given this, the current behavior is not a functional bug but rather the result of:

1. legacy tag-validation logic, and
2. the document-wide architecture of Check Issues.

The real inconsistency lies in the labeling, which does not clearly indicate that this option is tag-specific.

Proposal for This Ticket

To resolve this ticket cleanly:

1. Update the label of the option so it explicitly refers to tag integrity/file validity.
   Possible revised titles:

2. “Validate tags when leaving segment”

3. “Automatic tag integrity check on segment exit”

4. “Tag-only validation when changing segments”

5. Close this ticket after the label change, since the observed behavior matches the original design intention.

6. Open a separate feature request for extending the per-segment check to general QA, ideally with segment-scoped checks to avoid heavy document-wide processing.

Suggested Ticket Title Update

To reflect the real issue, the title could also be revised to something like:

“Rename segment-exit automatic check option to clarify it is tag-specific”

This keeps this ticket focused on UI clarity, and leaves functional enhancements to the new feature request.

[Jean-Christophe Helary]

Ok. We can revert to something like "Check tag issues when leaving the segment".

Our next issue (and @miurahr9, you mentioned that the other day) is that some language pairs that require tag order changes will always appear in the the issue window. So this function should be limited in scope to the segment, and not to the document or full project.

[Hiroshi Miura]

Uhm, I have just experienced a behavior @brandelune described in a case of #1308.
Dialog with the auto check when leaving segment, also checks spell checker and tag validator on OmegaT 6.0.x branch and also master branch.
It is just buggy.

[Hiroshi Miura]

In master branch, EditorController#commitAndDeactivate has a code

        // validate tags if required
        if (Preferences.isPreference(Preferences.TAG_VALIDATE_ON_LEAVE)) {
            String file = getCurrentFile();
            new SwingWorker<Boolean, Void>() {
                @Override
                protected Boolean doInBackground() throws Exception {
                    return Core.getTagValidation().checkInvalidTags(entry);
                }

                @Override
                protected void done() {
                    try {
                        if (Boolean.FALSE.equals(get())) {
                            Core.getIssues().showForFiles(Pattern.quote(file), entry.entryNum());
                        }
                    } catch (InterruptedException | ExecutionException e) {
                        Log.logErrorRB(e, "LOG_ERROR_TAG_VALIDATION_FAILED");
                    }
                }
            }.execute();
        }

Now doInBackground examine checkInvalidTags(entry) and done examine the result of tag validation by if (Boolean.FALSE.equals(get()))

This logic is the one JC explained, when tag error exists, check other issues. Otherwise skip another issues.

[Hiroshi Miura]

Historically Core.getIssues().showForFiles(Pattern.quote(file), entry.entryNum()); may just show the issues, but now it validate other issues.

Here is a chain; IssuePanelController#show -> IssuePanelController#refreshData -> new IssueLoader -> getProviderIssues()

This is an architecture design error that dialog controller handles validation.

And show is called when tag error exists.

[Hiroshi Miura]

It is requires deep redesign of core feature how validate issues, it will lead huge change.

[Hiroshi Miura]

I proposed the change https://github.com/omegat-org/omegat/pull/1802

[Jean-Christophe Helary]

Is this a fix for #1308 ? You mentioned above that the behavior was consistent with the design and that we just needed to relabel the UI.

[Hiroshi Miura]

The fix has been merged. It make OmegaT checks all the issue even when tag error does not exist.