Revised the IsSelectionAcrossHiddenAttributesMetadata() function to provide the user with a more understandable warning message. This routine also had a couple faulty msg.Format(...) statements that were not constructed properly resulting in the loss of the messages that were to be displayed, and only displayed the contents of the %s substitution strings.

Revised the AppendSrcPhraseEndingInfo() function to insert an EOL before certain markers that have been swept up markers in the process of filtering, such as a \c n chapter marker that should have an EOL before it so that it starts on a new line in exports.
Removed the "empty-key" filler words that can appear in the ParsePostWordPunctsAndEndMkrs() function. I think it is better to simply leave the m_key and m_srcPhrase empty as we do in other places for markers empty of content.
Made some adjustments to the DoMarkerHousekeeping() function to make it conform to the handling of inline nonbinding end markers elsewhere.
Provided more smarts for the GetPriorityBeginMkr() function and renamed it to GetPriorityTextTypeChangingBeginMkr(). The function now does not simply return the first or the last marker within m_markers, but examines the markers present and returns the last marker present that has an effect on the textType.
Added a return len statement at a critical juncture in ParseWord() which is needed to properly re-filter a data hiding marker after it has been unfiltered.
Needed to add an appropriate test within ParseWord() in order to properly call	 SetInlineBindingEndMarkers(), or etInlineBindingEndMarkers().
Added a fill filtering routine within an otherwise empty if (bIsToBeFiltered) block in TokenizeText(), to make it conform to other filtering blocks elsewhere.
Added a bKeepPtrFromAdvancing = TRUE statement at one point in TokenizeText() for when the marker detected is a within m_charAttributeMkrs.
Added a GetInlineNonbindingEndMarkersAsArray() function to CSourcePhrase class.

Author: pngbill

source/Adapt_ItDoc.cpp

@@ -498,7 +498,14 @@ bool	 bMarkAsDirty);					// might want it instantly saveable
 	wxString		GetLastBeginMkr(wxString mkrs); // BEW 13Dec22 get the last one in m_markers, but the last one
 						// does not always result in getting the correct TextType; but some places need this so keep it.
 						// However, GetPriorityBeginMkr() -- see next line, should do better job; get \v if present
-	wxString		GetPriorityBeginMkr(wxString mkrs); // BEW 2Aug23 get the priority beginMkr from m_markers, to set the TextType - \v if present
+						// 
+						// whm 12Mar2024 refactored and changed the name of the next function call. 
+						// The function previously was named GetPriorityMkr(), but is now named
+						// GetPriorityTextTypeChangingBeginMkr(). It now returns the first marker
+						// found within m_markers that is also found in the App's m_RegBeginMarkers 
+						// set, or if not present there, the last marker in m_markers is returned,
+						// or wxEmptyString if no markers are within m_markers.
+	wxString		GetPriorityTextTypeChangingBeginMkr(wxString mkrs); // BEW 2Aug23 get the priority beginMkr from m_markers, to set the TextType - \v if present
 	void			GetLengthToWhitespace(wxChar* pChar, unsigned int& counter, wxChar* pEnd); // BEW 20Oct22
 	bool			IsClosedParenthesisAhead(wxChar* pChar, unsigned int& count, wxChar* pEnd, CSourcePhrase* pSrcPhrase, bool& bTokenizingTargetText);
 	bool			IsClosedBraceAhead(wxChar* pChar, unsigned int& count, wxChar* pEnd, CSourcePhrase* pSrcPhrase, bool& bTokenizingTargetText);

source/Adapt_ItDoc.h

@@ -11022,7 +11022,15 @@ bool CAdapt_ItView::IsSelectionAcrossFreeTranslationEnd(SPList* pList)
 // Placement dialog which otherwise would not show, will show and the the user will have
 // to do a manual placement within it. (It's safer that way, than letting the cache data
 // be lost)
-bool CAdapt_ItView::IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, wxString &strAt)
+// whm 8Mar2024 modified this function to return more information so the user warning the
+// caller creates will be more understandable in the two places this function is called: 
+// In the View's OnButtonMerge(), and in Retranslation.cpp's OnButtonRetranslation().
+// The additional information is returned via ref parameters srcWords and mkrSpan
+//bool CAdapt_ItView::IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, wxString &strAt)
+bool CAdapt_ItView::IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, 
+	wxString& srcWords,
+	wxString& strAt,
+	wxString& mkrSpan)
 {
 	CSourcePhrase* pSrcPhrase;
 	SPList::Node* pos_pList = pList->GetFirst();
@@ -11035,17 +11043,35 @@ bool CAdapt_ItView::IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, wxS
 	// the span has both at different locations, the there is no clash, but the
 	// presence of attribute hiding wins out in the suppression stakes. So the
 	// simple double test below suffices
+	srcWords.Empty();
+	mkrSpan.Empty();
+	wxString beginMkr; beginMkr.Empty();
+	int wordNumber = 1;
+	int wordNumberAtHiddenData = -1;
 	while (pos_pList != NULL)
 	{
 		pSrcPhrase = (CSourcePhrase*)pos_pList->GetData();
-
+		srcWords += (_T(" ") + pSrcPhrase->m_srcPhrase);
+		beginMkr += pSrcPhrase->GetInlineNonbindingMarkers(); // the \jmp ...\jmp* maker is an inline nonbinding one
+		beginMkr += pSrcPhrase->GetInlineBindingMarkers(); // the \w ...\w* marker is an inline binding one
 		pos_pList = pos_pList->GetNext();
 		if ((pSrcPhrase->m_bUnused == TRUE) && (pSrcPhrase->m_bHasInternalPunct == FALSE))
 		{
 			bIllegalInternalHiddenMetadata = TRUE;
+			mkrSpan = pSrcPhrase->m_punctsPattern; 
 			strAt = pSrcPhrase->m_srcPhrase;
-			break;
+			wordNumberAtHiddenData = wordNumber;
+			//break; // we want the whole sublist traversed to collect the mkrSpan
 		}
+		wordNumber++;
+	}
+	if (bIllegalInternalHiddenMetadata)
+	{
+		wxString addEllipsis; addEllipsis.Empty();
+		srcWords.Trim(FALSE); // remove initial space
+		if (wordNumberAtHiddenData > 1)
+			addEllipsis = _T(" ... ");
+		mkrSpan = addEllipsis + beginMkr + mkrSpan; // the inline binding/nonbinding begin marker + m_punctsPattern contents.
 	}
 	return bIllegalInternalHiddenMetadata;
 }
@@ -11577,14 +11603,24 @@ void CAdapt_ItView::OnButtonMerge(wxCommandEvent& WXUNUSED(event))
 	// The signature param bIsMerger is default FALSE - see comment in Adapt_ItView.h for
 	// more information; since this is a merger attempt, TRUE must be overtly supplied
 	wxString strAt = wxEmptyString;
-	bIllegalInternalHiddenMetadata = IsSelectionAcrossHiddenAttributesMetadata(pList, strAt);
+	wxString srcWords = wxEmptyString;
+	wxString mkrSpan = wxEmptyString;
+	bIllegalInternalHiddenMetadata = IsSelectionAcrossHiddenAttributesMetadata(pList, srcWords, strAt, mkrSpan);
 	if (bIllegalInternalHiddenMetadata)
 	{
-		wxString msg = _("Merging across stored(hidden) USFM3 metadata is not allowed. The metadata is hidden at the word: %s");
-		msg = msg.Format(strAt.c_str());
+		// whm 8Mar2024 revised the warning message below to be more understandable to the user and also
+		// its original form didn't actually include the warning, only the single word passed into the %s due
+		// to a faulty .Format() call that didn't have the msg as first parameter of .Format().
+		// Also to supply more helpful information in the warning, I've added two parameters to the
+		// IsSelectionAcrossHiddenAttributesMetadata() function call above, with the necessary internal
+		// modifications.
+		//wxString msg = _("Merging across stored(hidden) USFM3 metadata is not allowed. The metadata is hidden at the word: %s");
+		//msg = msg.Format(strAt.c_str());
+		wxString msg = _("Adapt It attempted to make a phrase of the source words \" %s\".\nHowever, the word \"%s\" within this marker span:\n\n%s\n\nhas stored (hidden/filtered) data.\nMaking a phrase across stored (hidden/filtered) data is not allowed.");
+		msg = msg.Format(msg, srcWords.c_str(), strAt.c_str(), mkrSpan.c_str());
         // whm 15May2020 added below to supress phrasebox run-on due to handling of ENTER in CPhraseBox::OnKeyUp()
         pApp->m_bUserDlgOrMessageRequested = TRUE;
-        wxMessageBox(msg, _T(""), wxICON_EXCLAMATION | wxOK);
+        wxMessageBox(msg, _("Making a phrase across hidden data not allowed"), wxICON_EXCLAMATION | wxOK);
 		pList->Clear();
 		if (pList != NULL) // whm 11Jun12 added NULL test
 			delete pList;

source/Adapt_ItView.cpp

@@ -367,7 +367,14 @@ class CAdapt_ItView : public wxView
 	// BEW added 30Sept19 - function below: disallow Merge() or Retranslation if the returned bool  
 	// is TRUE. Tests; and does not allow hidden attribute metadata to be in *ANY* of the 
 	// CSourcePhrase instances of the selection
-	bool		IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, wxString &strAt);
+	// whm 8Mar2024 revised the following function to return more information to the caller so the
+	// caller can create a more informative warning message to the user.
+	//bool		IsSelectionAcrossHiddenAttributesMetadata(SPList* pList, wxString &strAt);
+	bool		IsSelectionAcrossHiddenAttributesMetadata(SPList* pList,
+		wxString& srcWords,
+		wxString& strAt,
+		wxString& mkrSpan);
+
 protected:
 	bool		RemoveInformationDuringEdit(CSourcePhrase* pSrcPhrase, int nSequNum, EditRecord* pRec,
 					wxArrayString* pAdaptList, wxArrayString* pGlossList, wxArrayString* pFTList,

source/Adapt_ItView.h

@@ -17182,7 +17182,7 @@ wxString AppendSrcPhraseEndingInfo(wxString appendHere, CSourcePhrase* pSrcPhras
 	{
 		if (!pSrcPhrase->GetInlineBindingEndMarkers().IsEmpty())
 		{
-			appendHere += pSrcPhrase->GetInlineBindingEndMarkers();
+			appendHere = pSrcPhrase->GetInlineBindingEndMarkers();
 			bAddedSomething = TRUE;
 		}
 		if (!pSrcPhrase->m_follPunct.IsEmpty())
@@ -17210,6 +17210,30 @@ wxString AppendSrcPhraseEndingInfo(wxString appendHere, CSourcePhrase* pSrcPhras
 	// function to this function since it should be the last thing added to appendHere.
 	if (!filteredInfo.IsEmpty())
 	{
+		// whm 13Mar2024 added a little hack to ensure that any initial swept up marker that
+		// is prefixed to the filteredInfo will start on a new line in the exported output. If the 
+		// filteredInfo has one of the swept up markers initially, and appendHere isn't empty 
+		// and doesn't end with and EOL sequence, then we add an EOL between the appendHere and 
+		// the swept up marker at the beginning of filteredInfo. This results in better formatting
+		// of the exported text and shouldn't foul up the other filtering routines that get called
+		// to normalize the exported text.
+		wxString initialMkr; initialMkr.Empty();
+		if (filteredInfo.Find(_T("\\")) == 0)
+		{
+			wxString space = _T(" ");
+			int spPos = filteredInfo.Find(space);
+			if (spPos != wxNOT_FOUND)
+			{
+				initialMkr = filteredInfo.Mid(0, spPos);
+				initialMkr.Trim();
+				initialMkr += space; // augmented for searching in m_markersCanBeSweptUpByFilteredMarker 
+			}
+		}
+		if (!appendHere.IsEmpty() && appendHere.Last() != _T('\n') && appendHere.Last() != _T('\r')
+			&& !initialMkr.IsEmpty() && gpApp->m_markersCanBeSweptUpByFilteredMarker.Find(initialMkr) != wxNOT_FOUND)
+		{
+			appendHere += _T("\r\n");
+		}
 		appendHere += filteredInfo;
 		bAddedSomething = TRUE;
 	}

source/ExportFunctions.cpp

@@ -2119,13 +2119,17 @@ void CRetranslation::OnButtonRetranslation(wxCommandEvent& event)
 	// the CSourcePhrase instances of the selection. In the call, signature's bIsMerger
 	// is default FALSE - which is appropriate for a retranslation
 	wxString strAt = wxEmptyString;
-	if (m_pView->IsSelectionAcrossHiddenAttributesMetadata(pList, strAt))
-	{
-		wxString msg = _("Sorry, this operation is not allowed when the selection contains hidden(stored) USFM3 metadata. Instead, try making retranslations either side of the word at %s.");
-		msg = msg.Format(strAt.c_str());
-        // whm 15May2020 added below to supress phrasebox run-on due to handling of ENTER in CPhraseBox::OnKeyUp()
+	wxString srcWords = wxEmptyString; wxUnusedVar(srcWords); // not used here
+	wxString mkrSpan = wxEmptyString;
+	if (m_pView->IsSelectionAcrossHiddenAttributesMetadata(pList, srcWords, strAt, mkrSpan))
+	{
+		wxString msg = _("Sorry, this operation is not allowed when the selection contains hidden (stored) data.\nThe hidden data is in this span of text:\n\n%s\n\nInstead, try making retranslations either side of the word at %s.");
+		// whm 8Mar2024 fixed the .Format() call below. The msg must be first parameter in the formatting call, i.e., .Format(msg, strAt.c_str())
+		// When the msg is missing the only string shown in the message box is the strAt word
+		msg = msg.Format(msg, mkrSpan.c_str(), strAt.c_str());
+		// whm 15May2020 added below to supress phrasebox run-on due to handling of ENTER in CPhraseBox::OnKeyUp()
         m_pApp->m_bUserDlgOrMessageRequested = TRUE;
-        wxMessageBox(msg, _T(""), wxICON_EXCLAMATION | wxOK);
+        wxMessageBox(msg, _("Cannot make a retranslation across hidden/stored data"), wxICON_EXCLAMATION | wxOK);
 		pList->Clear();
 		if (pList != NULL) // whm 11Jun12 added NULL test
 			delete pList;

source/Retranslation.cpp

@@ -2924,6 +2924,21 @@ bool CSourcePhrase::GetEndMarkersAsArray(wxArrayString* pEndmarkersArray)
 	return bGotSome;
 }
 
+bool CSourcePhrase::GetInlineNonbindingEndMarkersAsArray(wxArrayString* pINB_EndMkrsArray)
+{
+	pINB_EndMkrsArray->Empty();
+	bool bGotSome = FALSE;
+	if (m_inlineNonbindingEndMarkers.IsEmpty())
+	{
+		return FALSE;
+	}
+	else
+	{
+		bGotSome = GetSFMarkersAsArray(m_inlineNonbindingEndMarkers, *pINB_EndMkrsArray);
+	}
+	return bGotSome;
+}
+
 /* wrote this then found I didn't need it
 // GetAllEndMarkersAsArray gets from all storage locations for endmarkers on a
 // CSourcePhrase instance - there are 3 wxStrings it then must check and collect from.

source/SourcePhrase.cpp

@@ -306,6 +306,7 @@ class CSourcePhrase : public wxObject
 //#endif
 	wxString GetEndMarkers();
 	bool GetEndMarkersAsArray(wxArrayString* pEndmarkersArray); // return FALSE if empty, else TRUE
+	bool GetInlineNonbindingEndMarkersAsArray(wxArrayString* pINB_EndMkrsArray); // whm 11Mar2024 added
 	//bool GetAllEndMarkersAsArray(wxArrayString* pEndmarkersArray); // ditto, gets not just from
 				// m_endMarkers, but also from the two storage members for inline endmarkers
 	void SetFreeTrans(wxString freeTrans);